Scala Compiler2.13.18 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package model
  Definition Classes
    doc
-  package diagram
  Definition Classes
    model
- AbstractType
- AliasType
- Annotation
- AnnotationClass
- BoundedTypeParamConstraint
- Class
- CommentFactory
- Constraint
- Constructor
- Def
- DocTemplateEntity
- Entity
- EqualTypeParamConstraint
- HigherKinded
- ImplicitConversion
- ImplicitInScopeConstraint
- ImplicitMemberShadowing
- IndexModelFactory
- KnownTypeClassConstraint
- LowerBoundedTypeParamConstraint
- MemberEntity
- MemberLookup
- MemberTemplateEntity
- ModelFactory
- ModelFactoryImplicitSupport
- ModelFactoryTypeSupport
- NoDocTemplate
- NonTemplateMemberEntity
- Object
- Package
- ParameterEntity
- PrivateInInstance
- PrivateInTemplate
- ProtectedInInstance
- ProtectedInTemplate
- Public
- RootPackage
- TemplateEntity
- Trait
- TreeEntity
- TreeFactory
- TypeClassConstraint
- TypeEntity
- TypeParam
- TypeParamConstraint
- UpperBoundedTypeParamConstraint
- Val
- ValueArgument
- ValueParam
- Visibility

t

scala.tools.nsc.doc.model

# MemberEntity

###
Companion object MemberEntity

#### 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

Linear Supertypes
Entity, AnyRef, Any
Known Subclasses
AbstractType, AliasType, AnnotationClass, Class, Constructor, Def, DocTemplateEntity, MemberTemplateEntity, DocTemplateImpl, MemberImpl, MemberTemplateImpl, NonTemplateMemberImpl, NonTemplateParamMemberImpl, PackageImpl, RootPackageImpl, NonTemplateMemberEntity, Object, Package, RootPackage, Trait, Val
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MemberEntity
2. Entity
3. AnyRef
4. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Abstract Value Members

1.  abstract def annotations: List[Annotation]

   The annotations attached to this entity, if any.

   The annotations attached to this entity, if any.

   Definition Classes
     Entity
2.  abstract def byConversion: Option[ImplicitConversion]

   If this member originates from an implicit conversion, we set the implicit information to the correct origin

3.  abstract def comment: Option[Comment]

   The comment attached to this member, if any.

4.  abstract def definitionName: String

   The qualified name of the member in its currently active declaration template.

5.  abstract def deprecation: Option[Body]

   Some deprecation message if this member is deprecated, or none otherwise.

6.  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`, and `final`.

7.  abstract def group: String

   The group this member is from

8.  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 of `inTemplate`.

9.  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
10.  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
11.  abstract def isAbstract: Boolean

    Whether this member is abstract.

12.  abstract def isAbstractType: Boolean

    Whether this member is an abstract type.

13.  abstract def isAliasType: Boolean

    Whether this member is an alias type.

14.  abstract def isAmbiguousImplicit: Boolean

    Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)

15.  abstract def isConstructor: Boolean

    Whether this member is a constructor.

16.  abstract def isDef: Boolean

    Whether this member is a method.

17.  abstract def isImplicitlyInherited: Boolean

    Indicates whether the member is inherited by implicit conversion

18.  abstract def isLazyVal: Boolean

    Whether this member is a lazy value.

19.  abstract def isShadowedImplicit: Boolean

    Indicates whether there is another member with the same name in the template that will take precedence

20.  abstract def isShadowedOrAmbiguousImplicit: Boolean

    Indicates whether the implicitly inherited member is shadowed or ambiguous in its template

21.  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
22.  abstract def isVal: Boolean

    Whether this member is a value (this excludes lazy values).

23.  abstract def isVar: Boolean

    Whether this member is a variable.

24.  abstract def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
      Entity
25.  abstract def migration: Option[Body]

    Some migration warning if this member has a migration annotation, or none otherwise.

26.  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
27.  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
28.  abstract def resultType: TypeEntity

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

29.  abstract def signature: String

    The identity of this member, used for linking

30.  abstract def signatureCompat: String

    Compatibility signature, will be removed from future versions

31.  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
32.  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
33.  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.

34.  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

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from MemberEntity toany2stringadd[MemberEntity] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (MemberEntity, B)
   Implicit
     This member is added by an implicit conversion from MemberEntity toArrowAssoc[MemberEntity] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (MemberEntity) => Boolean, msg: => Any): MemberEntity
   Implicit
     This member is added by an implicit conversion from MemberEntity toEnsuring[MemberEntity] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (MemberEntity) => Boolean): MemberEntity
   Implicit
     This member is added by an implicit conversion from MemberEntity toEnsuring[MemberEntity] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): MemberEntity
    Implicit
      This member is added by an implicit conversion from MemberEntity toEnsuring[MemberEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): MemberEntity
    Implicit
      This member is added by an implicit conversion from MemberEntity toEnsuring[MemberEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
      Entity → AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from MemberEntity toStringFormat[MemberEntity] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (MemberEntity, B)
   Implicit
     This member is added by an implicit conversion from MemberEntity toArrowAssoc[MemberEntity] 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.

### Inherited from Entity

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromMemberEntity to any2stringadd[MemberEntity]

### Inherited by implicit conversion StringFormat fromMemberEntity to StringFormat[MemberEntity]

### Inherited by implicit conversion Ensuring fromMemberEntity to Ensuring[MemberEntity]

### Inherited by implicit conversion ArrowAssoc fromMemberEntity to ArrowAssoc[MemberEntity]

### Ungrouped