trait MemberEntity extends Entity
An entity that is a member of a template. All entities, including templates, are member of another entity except for parameters and annotations. Note that all members of a template are modelled, including those that are inherited and not declared locally.
- Source
- Entity.scala
- Alphabetic
- By Inheritance
- MemberEntity
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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
-
abstract
def
comment: Option[Comment]
The comment attached to this member, if any.
-
abstract
def
definitionName: String
The qualified name of the member in its currently active declaration template.
-
abstract
def
deprecation: Option[Body]
Some deprecation message if this member is deprecated, or none otherwise.
-
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
. -
abstract
def
group: String
The group this member is from
-
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
. -
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.
-
abstract
def
isAbstractType: Boolean
Whether this member is an abstract type.
-
abstract
def
isAliasType: Boolean
Whether this member is an alias type.
-
abstract
def
isAmbiguousImplicit: Boolean
Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)
-
abstract
def
isConstructor: Boolean
Whether this member is a constructor.
-
abstract
def
isDef: Boolean
Whether this member is a method.
-
abstract
def
isImplicitlyInherited: Boolean
Indicates whether the member is inherited by implicit conversion
-
abstract
def
isLazyVal: Boolean
Whether this member is a lazy value.
-
abstract
def
isShadowedImplicit: Boolean
Indicates whether there is another member with the same name in the template that will take precedence
-
abstract
def
isShadowedOrAmbiguousImplicit: Boolean
Indicates whether the implicitly inherited member is shadowed or ambiguous in its template
-
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
isVal: Boolean
Whether this member is a value (this excludes lazy values).
-
abstract
def
isVar: Boolean
Whether this member is a variable.
-
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.
-
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
qualifiedName
instead.- 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.
-
abstract
def
signature: String
The identity of this member, used for linking
-
abstract
def
signatureCompat: String
Compatibility signature, will be removed from future versions
-
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.
-
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.
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 MemberEntity to any2stringadd[MemberEntity] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (MemberEntity, B)
- Implicit
- This member is added by an implicit conversion from MemberEntity to ArrowAssoc[MemberEntity] 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
ensuring(cond: (MemberEntity) ⇒ Boolean, msg: ⇒ Any): MemberEntity
- Implicit
- This member is added by an implicit conversion from MemberEntity to Ensuring[MemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (MemberEntity) ⇒ Boolean): MemberEntity
- Implicit
- This member is added by an implicit conversion from MemberEntity to Ensuring[MemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): MemberEntity
- Implicit
- This member is added by an implicit conversion from MemberEntity to Ensuring[MemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): MemberEntity
- Implicit
- This member is added by an implicit conversion from MemberEntity to Ensuring[MemberEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MemberEntity to StringFormat[MemberEntity] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): java.lang.Class[_]
- 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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
→[B](y: B): (MemberEntity, B)
- Implicit
- This member is added by an implicit conversion from MemberEntity to ArrowAssoc[MemberEntity] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
The Scala compiler and reflection APIs.