Scala Compiler 2.13.16 - scala.tools.nsc.doc.model.ModelFactory.MemberTemplateImpl
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.model.ModelFactory.MemberTemplateImpl

Scala Compiler2.13.16 < 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

# MemberTemplateImpl

###

#### abstract class MemberTemplateImpl extends (ModelFactory.this)#MemberImpl with (ModelFactory.this)#TemplateImpl with (ModelFactory.this)#HigherKindedImpl with MemberTemplateEntity

An inherited template that was not documented in its original owner - example: in classpath: trait T { class C } -- T (and implicitly C) are not documented in the source: trait U extends T -- C appears in U as a MemberTemplateImpl -- that is, U has a member for it but C doesn't get its own page

Source
  ModelFactory.scala

Linear Supertypes
MemberTemplateEntity, (ModelFactory.this)#HigherKindedImpl, HigherKinded, (ModelFactory.this)#TemplateImpl, TemplateEntity, (ModelFactory.this)#MemberImpl, MemberEntity, (ModelFactory.this)#EntityImpl, Entity, AnyRef, Any
Known Subclasses
DocTemplateImpl, PackageImpl, RootPackageImpl
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MemberTemplateImpl
2. MemberTemplateEntity
3. HigherKindedImpl
4. HigherKinded
5. TemplateImpl
6. TemplateEntity
7. MemberImpl
8. MemberEntity
9. EntityImpl
10. Entity
11. AnyRef
12. 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 MemberTemplateImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl)

### Abstract Value Members

1.  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)#MemberTemplateImpl toany2stringadd[(ModelFactory.this)#MemberTemplateImpl] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): ((ModelFactory.this)#MemberTemplateImpl, B)
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#MemberTemplateImpl toArrowAssoc[(ModelFactory.this)#MemberTemplateImpl] 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]
    Definition Classes
      MemberImpl
12.  lazy val 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
      MemberTemplateImpl → MemberEntity
13.  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
14.  def ensuring(cond: ((ModelFactory.this)#MemberTemplateImpl) => Boolean, msg: => Any): (ModelFactory.this)#MemberTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberTemplateImpl toEnsuring[(ModelFactory.this)#MemberTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: ((ModelFactory.this)#MemberTemplateImpl) => Boolean): (ModelFactory.this)#MemberTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberTemplateImpl toEnsuring[(ModelFactory.this)#MemberTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean, msg: => Any): (ModelFactory.this)#MemberTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberTemplateImpl toEnsuring[(ModelFactory.this)#MemberTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  def ensuring(cond: Boolean): (ModelFactory.this)#MemberTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#MemberTemplateImpl toEnsuring[(ModelFactory.this)#MemberTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
18.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
20.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
21.  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
22.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
23.  def group: String

    The group this member is from

    The group this member is from

    Definition Classes
      MemberImpl → MemberEntity
24.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
25.  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
26.  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
27.  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
28.  val inTpl: (ModelFactory.this)#TemplateImpl
    Definition Classes
      EntityImpl
29.  def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

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

    Whether this member is an abstract type.

    Whether this member is an abstract type.

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

    Whether this member is an alias type.

    Whether this member is an alias type.

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

    Whether this template is a case class or a case object.

    Whether this template is a case class or a case object.

    Definition Classes
      TemplateImpl → TemplateEntity
34.  def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
      TemplateImpl → TemplateEntity
35.  def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

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

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
      MemberImpl → MemberEntity
37.  def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
      MemberTemplateImpl → TemplateEntity
38.  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
39.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
40.  def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
      MemberImpl → MemberEntity
41.  def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
      TemplateImpl → TemplateEntity
42.  def isPackage: Boolean

    Whether this template is a package (including the root package).

    Whether this template is a package (including the root package).

    Definition Classes
      TemplateImpl → TemplateEntity
43.  def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
      TemplateImpl → TemplateEntity
44.  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
45.  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
46.  def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
      TemplateImpl → TemplateEntity
47.  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
48.  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
49.  def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
      MemberImpl → MemberEntity
50.  def linkTarget: (ModelFactory.this)#DocTemplateImpl
    Definition Classes
      MemberImpl
51.  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
52.  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
53.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
54.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
55.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
56.  def parentTypes: List[(TemplateEntity, TypeEntity)]

    TODO, these are now only computed for DocTemplates

    TODO, these are now only computed for DocTemplates

    Definition Classes
      MemberTemplateImpl → MemberTemplateEntity
57.  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
      TemplateImpl → EntityImpl → Entity
58.  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
59.  def selfType: Option[TypeEntity]

    The self-type of this template, if it differs from the template type.

    The self-type of this template, if it differs from the template type.

    Definition Classes
      TemplateImpl → TemplateEntity
60.  def signature: String

    The identity of this member, used for linking

    The identity of this member, used for linking

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

    Compatibility signature, will be removed from future versions

    Compatibility signature, will be removed from future versions

    Definition Classes
      MemberImpl → MemberEntity
62.  val sym: Global.Symbol
    Definition Classes
      EntityImpl
63.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
64.  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
65.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
      Entity → AnyRef → Any
66.  def typeParams: collection.immutable.List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
      HigherKindedImpl → HigherKinded
67.  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
68.  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
69.  def valueParams: List[List[ValueParam]]

    The value parameters of this case class, or an empty list if this class is not a case class.

    The value parameters of this case class, or an empty list if this class is not a case class. As case class value parameters cannot be curried, the outer list has exactly one element.

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

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

### Inherited from HigherKinded

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

### Inherited from TemplateEntity

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

### 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)#MemberTemplateImpl to any2stringadd[(ModelFactory.this)#MemberTemplateImpl]

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

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

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

### Ungrouped