trait NonTemplateMemberEntity extends MemberEntity
A non-template member (method, value, lazy value, variable, constructor, alias type, and abstract type).
- Source
- Entity.scala
- Alphabetic
- By Inheritance
- NonTemplateMemberEntity
- MemberEntity
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def annotations: List[Annotation]
The annotations attached to this entity, if any.
The annotations attached to this entity, if any.
- Definition Classes
- Entity
- abstract def byConversion: Option[ImplicitConversion]
If this member originates from an implicit conversion, we set the implicit information to the correct origin
If this member originates from an implicit conversion, we set the implicit information to the correct origin
- Definition Classes
- MemberEntity
- abstract def comment: Option[Comment]
The comment attached to this member, if any.
The comment attached to this member, if any.
- Definition Classes
- MemberEntity
- abstract def definitionName: String
The qualified name of the member in its currently active declaration template.
The qualified name of the member in its currently active declaration template.
- Definition Classes
- MemberEntity
- abstract def deprecation: Option[Body]
Some deprecation message if this member is deprecated, or none otherwise.
Some deprecation message if this member is deprecated, or none otherwise.
- Definition Classes
- MemberEntity
- abstract def flags: List[Paragraph]
The flags that have been set for this entity.
The flags that have been set for this entity. The following flags are supported:
implicit,sealed,abstract, andfinal.- Definition Classes
- MemberEntity
- abstract def group: String
The group this member is from
The group this member is from
- Definition Classes
- MemberEntity
- abstract def inDefinitionTemplates: List[TemplateEntity]
The templates in which this member has been declared.
The templates in which this member has been declared. The first element of the list is the template that contains the currently active declaration of this member, subsequent elements are declarations that have been overridden. If the first element is equal to
inTemplate, the member is declared locally, if not, it has been inherited. All elements of this list are in the linearization ofinTemplate.- Definition Classes
- MemberEntity
- abstract def inPackageObject: Boolean
Whether or not the template was defined in a package object
Whether or not the template was defined in a package object
- Definition Classes
- Entity
- abstract def inTemplate: DocTemplateEntity
The template of which this entity is a member.
The template of which this entity is a member.
- Definition Classes
- MemberEntity → Entity
- abstract def isAbstract: Boolean
Whether this member is abstract.
Whether this member is abstract.
- Definition Classes
- MemberEntity
- abstract def isAbstractType: Boolean
Whether this member is an abstract type.
Whether this member is an abstract type.
- Definition Classes
- MemberEntity
- abstract def isAliasType: Boolean
Whether this member is an alias type.
Whether this member is an alias type.
- Definition Classes
- MemberEntity
- abstract def isAmbiguousImplicit: Boolean
Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)
Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)
- Definition Classes
- MemberEntity
- abstract def isConstructor: Boolean
Whether this member is a constructor.
Whether this member is a constructor.
- Definition Classes
- MemberEntity
- abstract def isDef: Boolean
Whether this member is a method.
Whether this member is a method.
- Definition Classes
- MemberEntity
- abstract def isImplicitlyInherited: Boolean
Indicates whether the member is inherited by implicit conversion
Indicates whether the member is inherited by implicit conversion
- Definition Classes
- MemberEntity
- abstract def isLazyVal: Boolean
Whether this member is a lazy value.
Whether this member is a lazy value.
- Definition Classes
- MemberEntity
- abstract def isShadowedImplicit: Boolean
Indicates whether there is another member with the same name in the template that will take precedence
Indicates whether there is another member with the same name in the template that will take precedence
- Definition Classes
- MemberEntity
- abstract def isShadowedOrAmbiguousImplicit: Boolean
Indicates whether the implicitly inherited member is shadowed or ambiguous in its template
Indicates whether the implicitly inherited member is shadowed or ambiguous in its template
- Definition Classes
- MemberEntity
- abstract def isType: Boolean
Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)
Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)
- Definition Classes
- Entity
- abstract def isUseCase: Boolean
Whether this member is a use case.
Whether this member is a use case. A use case is a member which does not exist in the documented code. It corresponds to a real member, and provides a simplified, yet compatible signature for that member.
- abstract def isVal: Boolean
Whether this member is a value (this excludes lazy values).
Whether this member is a value (this excludes lazy values).
- Definition Classes
- MemberEntity
- abstract def isVar: Boolean
Whether this member is a variable.
Whether this member is a variable.
- Definition Classes
- MemberEntity
- abstract def kind: String
The kind of the entity
The kind of the entity
- Definition Classes
- Entity
- abstract def migration: Option[Body]
Some migration warning if this member has a migration annotation, or none otherwise.
Some migration warning if this member has a migration annotation, or none otherwise.
- Definition Classes
- MemberEntity
- abstract def name: String
The name of the entity.
The name of the entity. Note that the name does not qualify this entity uniquely; use its
qualifiedNameinstead.- Definition Classes
- Entity
- abstract def qualifiedName: String
The qualified name of the entity.
The qualified name of the entity. This is this entity's name preceded by the qualified name of the template of which this entity is a member. The qualified name is unique to this entity.
- Definition Classes
- Entity
- abstract def resultType: TypeEntity
For members representing values: the type of the value returned by this member; for members representing types: the type itself.
For members representing values: the type of the value returned by this member; for members representing types: the type itself.
- Definition Classes
- MemberEntity
- abstract def signature: String
The identity of this member, used for linking
The identity of this member, used for linking
- Definition Classes
- MemberEntity
- abstract def signatureCompat: String
Compatibility signature, will be removed from future versions
Compatibility signature, will be removed from future versions
- Definition Classes
- MemberEntity
- abstract def toRoot: List[MemberEntity]
The list of entities such that each is a member of the entity that follows it; the first entity is always this member, the last the root package entity.
The list of entities such that each is a member of the entity that follows it; the first entity is always this member, the last the root package entity.
- Definition Classes
- MemberEntity → Entity
- abstract def universe: Universe
The Scaladoc universe of which this entity is a member.
The Scaladoc universe of which this entity is a member.
- Definition Classes
- Entity
- abstract def useCaseOf: Option[MemberEntity]
If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.
If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.
- Definition Classes
- MemberEntity
- abstract def visibility: Visibility
The visibility of this member.
The visibility of this member. Note that members with restricted visibility may not be modeled in some universes.
- Definition Classes
- MemberEntity
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toany2stringadd[NonTemplateMemberEntity] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (NonTemplateMemberEntity, B)
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toArrowAssoc[NonTemplateMemberEntity] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (NonTemplateMemberEntity) => Boolean, msg: => Any): NonTemplateMemberEntity
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toEnsuring[NonTemplateMemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (NonTemplateMemberEntity) => Boolean): NonTemplateMemberEntity
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toEnsuring[NonTemplateMemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): NonTemplateMemberEntity
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toEnsuring[NonTemplateMemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): NonTemplateMemberEntity
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toEnsuring[NonTemplateMemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): java.lang.Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
The qualified name of this entity.
The qualified name of this entity.
- Definition Classes
- Entity → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toStringFormat[NonTemplateMemberEntity] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (NonTemplateMemberEntity, B)
- Implicit
- This member is added by an implicit conversion from NonTemplateMemberEntity toArrowAssoc[NonTemplateMemberEntity] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
The Scala compiler and reflection APIs.