Scala Compiler2.13.17 < 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
-  class ModelFactory extends AnyRef

  This trait extracts all required information for documentation from compilation units

  This trait extracts all required information for documentation from compilation units

  Definition Classes
    model
- DocTemplateImpl
- EntityImpl
- HigherKindedImpl
- MemberImpl
- MemberTemplateImpl
- NoDocTemplateImpl
- NonTemplateMemberImpl
- NonTemplateParamMemberImpl
- PackageImpl
- ParameterImpl
- RootPackageImpl
- TemplateImpl
- modelCreation

c

scala.tools.nsc.doc.model.ModelFactory

# MemberImpl

###

#### abstract class MemberImpl extends (ModelFactory.this)#EntityImpl with MemberEntity

Source
  ModelFactory.scala

Linear Supertypes
MemberEntity, (ModelFactory.this)#EntityImpl, Entity, AnyRef, Any
Known Subclasses
DocTemplateImpl, MemberTemplateImpl, NonTemplateMemberImpl, NonTemplateParamMemberImpl, PackageImpl, RootPackageImpl
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MemberImpl
2. MemberEntity
3. EntityImpl
4. Entity
5. AnyRef
6. 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

### Instance Constructors

1.  new MemberImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl)

### Abstract Value Members

1.  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
2.  abstract def kind: String

   The kind of the entity

   The kind of the entity

   Definition Classes
     Entity

### 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 (ModelFactory.this)#MemberImpl toany2stringadd[(ModelFactory.this)#MemberImpl] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): ((ModelFactory.this)#MemberImpl, B)
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toArrowAssoc[(ModelFactory.this)#MemberImpl] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def annotations: collection.immutable.List[Annotation]

   The annotations attached to this entity, if any.

   The annotations attached to this entity, if any.

   Definition Classes
     EntityImpl → Entity
7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def byConversion: Option[(ModelFactory.this)#ImplicitConversionImpl]

   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
     MemberImpl → MemberEntity
9.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
10.  lazy val comment: Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Definition Classes
      MemberImpl → MemberEntity
11.  def commentCarryingSymbol(sym: Global.Symbol): Global.Symbol
    Attributes
      protected[this]
12.  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
      MemberImpl → MemberEntity
13.  def ensuring(cond: ((ModelFactory.this)#MemberImpl) => Boolean, msg: => Any): (ModelFactory.this)#MemberImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toEnsuring[(ModelFactory.this)#MemberImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: ((ModelFactory.this)#MemberImpl) => Boolean): (ModelFactory.this)#MemberImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toEnsuring[(ModelFactory.this)#MemberImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean, msg: => Any): (ModelFactory.this)#MemberImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toEnsuring[(ModelFactory.this)#MemberImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean): (ModelFactory.this)#MemberImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toEnsuring[(ModelFactory.this)#MemberImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
19.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
20.  def flags: collection.immutable.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`.

    Definition Classes
      MemberImpl → MemberEntity
21.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  def group: String

    The group this member is from

    The group this member is from

    Definition Classes
      MemberImpl → MemberEntity
23.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
24.  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`.

    Definition Classes
      MemberImpl → MemberEntity
25.  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
      EntityImpl → Entity
26.  def inTemplate: (ModelFactory.this)#DocTemplateImpl

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
      MemberImpl → MemberEntity → EntityImpl → Entity
27.  val inTpl: (ModelFactory.this)#TemplateImpl
    Definition Classes
      EntityImpl
28.  def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
      MemberImpl → MemberEntity
29.  def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
      MemberImpl → MemberEntity
30.  def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
      MemberImpl → MemberEntity
31.  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
      MemberImpl → MemberEntity
32.  def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
      MemberImpl → MemberEntity
33.  def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
      MemberImpl → MemberEntity
34.  def isImplicitlyInherited: Boolean

    Indicates whether the member is inherited by implicit conversion

    Indicates whether the member is inherited by implicit conversion

    Definition Classes
      MemberImpl → MemberEntity
35.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
36.  def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
      MemberImpl → MemberEntity
37.  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
      MemberImpl → MemberEntity
38.  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
      MemberImpl → MemberEntity
39.  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
      EntityImpl → Entity
40.  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
      MemberImpl → MemberEntity
41.  def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
      MemberImpl → MemberEntity
42.  def linkTarget: (ModelFactory.this)#DocTemplateImpl
43.  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
      MemberImpl → MemberEntity
44.  val 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
      EntityImpl → Entity
45.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
46.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
47.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
48.  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
      EntityImpl → Entity
49.  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
      MemberImpl → MemberEntity
50.  def signature: String

    The identity of this member, used for linking

    The identity of this member, used for linking

    Definition Classes
      MemberImpl → MemberEntity
51.  lazy val signatureCompat: String

    Compatibility signature, will be removed from future versions

    Compatibility signature, will be removed from future versions

    Definition Classes
      MemberImpl → MemberEntity
52.  val sym: Global.Symbol
    Definition Classes
      EntityImpl
53.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
54.  def toRoot: List[(ModelFactory.this)#MemberImpl]

    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
      MemberImpl → MemberEntity → EntityImpl → Entity
55.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
      Entity → AnyRef → Any
56.  val universe: Universe

    The Scaladoc universe of which this entity is a member.

    The Scaladoc universe of which this entity is a member.

    Definition Classes
      EntityImpl → Entity
57.  def useCaseOf: Option[(ModelFactory.this)#MemberImpl]

    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
      MemberImpl → MemberEntity
58.  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
      MemberImpl → MemberEntity
59.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
60.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
61.  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 (ModelFactory.this)#MemberImpl toStringFormat[(ModelFactory.this)#MemberImpl] 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): ((ModelFactory.this)#MemberImpl, B)
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#MemberImpl toArrowAssoc[(ModelFactory.this)#MemberImpl] 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 MemberEntity

### Inherited from (ModelFactory.this)#EntityImpl

### Inherited from Entity

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from(ModelFactory.this)#MemberImpl to any2stringadd[(ModelFactory.this)#MemberImpl]

### Inherited by implicit conversion StringFormat from(ModelFactory.this)#MemberImpl to StringFormat[(ModelFactory.this)#MemberImpl]

### Inherited by implicit conversion Ensuring from(ModelFactory.this)#MemberImpl to Ensuring[(ModelFactory.this)#MemberImpl]

### Inherited by implicit conversion ArrowAssoc from(ModelFactory.this)#MemberImpl to ArrowAssoc[(ModelFactory.this)#MemberImpl]

### Ungrouped