abstract class PackageImpl extends (ModelFactory.this)#DocTemplateImpl with Package
- Alphabetic
- By Inheritance
- PackageImpl
- Package
- DocTemplateImpl
- DocTemplateEntity
- MemberTemplateImpl
- MemberTemplateEntity
- HigherKindedImpl
- HigherKinded
- TemplateImpl
- TemplateEntity
- MemberImpl
- MemberEntity
- EntityImpl
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PackageImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#PackageImpl)
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 (ModelFactory.this)#PackageImpl toany2stringadd[(ModelFactory.this)#PackageImpl] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): ((ModelFactory.this)#PackageImpl, B)
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toArrowAssoc[(ModelFactory.this)#PackageImpl] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def abstractTypes: collection.immutable.List[AbstractType]
All abstract types that are members of this template.
All abstract types that are members of this template.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def aliasTypes: collection.immutable.List[AliasType]
All type aliases that are members of this template.
All type aliases that are members of this template.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- def commentCarryingSymbol(sym: Global.Symbol): Global.Symbol
- Attributes
- protected[this]
- Definition Classes
- MemberImpl
- def companion: Option[DocTemplateEntity]
The companion of this template, or none.
The companion of this template, or none. If a class and an object are defined as a pair of the same name, the other entity of the pair is the companion.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def completeModel(): Unit
This is the final point in the core model creation: no DocTemplates are created after the model has finished, but inherited templates and implicit members are added to the members at this point.
This is the final point in the core model creation: no DocTemplates are created after the model has finished, but inherited templates and implicit members are added to the members at this point.
- Definition Classes
- DocTemplateImpl
- def constructors: List[(ModelFactory.this)#MemberImpl with Constructor]
All constructors of this class, including the primary constructor.
All constructors of this class, including the primary constructor.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def contentDiagram: Option[Diagram]
If this template contains other templates, such as classes and traits, they will be shown in this diagram
If this template contains other templates, such as classes and traits, they will be shown in this diagram
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- val conversions: List[(ModelFactory.this)#ImplicitConversionImpl]
The implicit conversions this template (class or trait, objects and packages are not affected)
The implicit conversions this template (class or trait, objects and packages are not affected)
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- 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
- def directSubClasses: List[DocTemplateEntity]
All class, trait and object templates for which this template is a *direct* super-class or super-trait.
All class, trait and object templates for which this template is a *direct* super-class or super-trait. Only templates for which documentation is available in the universe (
DocTemplateEntity) are listed.- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def ensuring(cond: ((ModelFactory.this)#PackageImpl) => Boolean, msg: => Any): (ModelFactory.this)#PackageImpl
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toEnsuring[(ModelFactory.this)#PackageImpl] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: ((ModelFactory.this)#PackageImpl) => Boolean): (ModelFactory.this)#PackageImpl
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toEnsuring[(ModelFactory.this)#PackageImpl] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): (ModelFactory.this)#PackageImpl
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toEnsuring[(ModelFactory.this)#PackageImpl] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): (ModelFactory.this)#PackageImpl
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toEnsuring[(ModelFactory.this)#PackageImpl] 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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, andfinal.- Definition Classes
- MemberImpl → MemberEntity
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toStringFormat[(ModelFactory.this)#PackageImpl] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): java.lang.Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def group: String
The group this member is from
The group this member is from
- Definition Classes
- MemberImpl → MemberEntity
- def groupDescription(group: String): Option[Body]
Returns the group description taken either from this template or its linearizationTypes
Returns the group description taken either from this template or its linearizationTypes
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def groupName(group: String): String
Returns the group description taken either from this template or its linearizationTypes
Returns the group description taken either from this template or its linearizationTypes
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def groupPriority(group: String): Int
Returns the group description taken either from this template or its linearizationTypes
Returns the group description taken either from this template or its linearizationTypes
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def groupSearch[T](extractor: (Comment) => Option[T]): Option[T]
- Definition Classes
- DocTemplateImpl
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- var implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]
The shadowing information for the implicitly added members
The shadowing information for the implicitly added members
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- MemberImpl → MemberEntity
- 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
- def inSource: Option[(AbstractFile, Int)]
The source file in which the current template is defined and the line where the definition starts, if they exist.
The source file in which the current template is defined and the line where the definition starts, if they exist. A source file exists for all templates, except for those that are generated synthetically by Scaladoc.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def inTemplate: (ModelFactory.this)#PackageImpl
The package of which this package is a member.
The package of which this package is a member.
- Definition Classes
- PackageImpl → Package → MemberImpl → MemberEntity → EntityImpl → Entity
- val inTpl: (ModelFactory.this)#TemplateImpl
- Definition Classes
- EntityImpl
- def incomingImplicitlyConvertedClasses: List[((ModelFactory.this)#DocTemplateImpl, (ModelFactory.this)#ImplicitConversionImpl)]
Classes that can be implicitly converted to this class
Classes that can be implicitly converted to this class
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def inheritanceDiagram: Option[Diagram]
If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram
If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def isAbstract: Boolean
Whether this member is abstract.
Whether this member is abstract.
- Definition Classes
- MemberImpl → MemberEntity
- def isAbstractType: Boolean
Whether this member is an abstract type.
Whether this member is an abstract type.
- Definition Classes
- MemberImpl → MemberEntity
- def isAliasType: Boolean
Whether this member is an alias type.
Whether this member is an alias type.
- Definition Classes
- MemberImpl → MemberEntity
- 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
- def isCaseClass: Boolean
Whether this template is a case class.
Whether this template is a case class.
- Definition Classes
- TemplateImpl → TemplateEntity
- def isClass: Boolean
Whether this template is a class.
Whether this template is a class.
- Definition Classes
- TemplateImpl → TemplateEntity
- def isConstructor: Boolean
Whether this member is a constructor.
Whether this member is a constructor.
- Definition Classes
- MemberImpl → MemberEntity
- def isDef: Boolean
Whether this member is a method.
Whether this member is a method.
- Definition Classes
- MemberImpl → MemberEntity
- def isDocTemplate: Boolean
Whether documentation is available for this template.
Whether documentation is available for this template.
- Definition Classes
- DocTemplateImpl → MemberTemplateImpl → TemplateEntity
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLazyVal: Boolean
Whether this member is a lazy value.
Whether this member is a lazy value.
- Definition Classes
- MemberImpl → MemberEntity
- def isObject: Boolean
Whether this template is an object.
Whether this template is an object.
- Definition Classes
- TemplateImpl → TemplateEntity
- 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
- def isRootPackage: Boolean
Whether this template is the root package.
Whether this template is the root package.
- Definition Classes
- TemplateImpl → TemplateEntity
- 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
- 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
- def isTrait: Boolean
Whether this template is a trait.
Whether this template is a trait.
- Definition Classes
- TemplateImpl → TemplateEntity
- 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
- 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
- def isVar: Boolean
Whether this member is a variable.
Whether this member is a variable.
- Definition Classes
- MemberImpl → MemberEntity
- def kind: String
The kind of the entity
- lazy val linearizationTemplates: collection.immutable.List[(ModelFactory.this)#TemplateImpl]
All class, trait and object templates which are part of this template's linearization, in linearization order.
All class, trait and object templates which are part of this template's linearization, in linearization order. This template's linearization contains all of its direct and indirect super-classes and super-traits.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- lazy val linearizationTypes: collection.immutable.List[TypeEntity]
All instantiated types which are part of this template's linearization, in linearization order.
All instantiated types which are part of this template's linearization, in linearization order. This template's linearization contains all of its direct and indirect super-types.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def linkTarget: (ModelFactory.this)#DocTemplateImpl
- Definition Classes
- DocTemplateImpl → MemberImpl
- lazy val memberSyms: List[Global.Symbol]
- Definition Classes
- DocTemplateImpl
- val memberSymsEager: collection.immutable.List[Global.Symbol]
- Definition Classes
- DocTemplateImpl
- val memberSymsLazy: collection.immutable.List[Global.Symbol]
- Definition Classes
- DocTemplateImpl
- var members: List[(ModelFactory.this)#MemberImpl]
All members of this template.
All members of this template. If this template is a package, only templates for which documentation is available in the universe (
DocTemplateEntity) are listed.- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def methods: collection.immutable.List[Def]
All methods that are members of this template.
All methods that are members of this template.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- 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
qualifiedNameinstead.- Definition Classes
- EntityImpl → Entity
- 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()
- lazy val outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, (ModelFactory.this)#ImplicitConversionImpl)]
Classes to which this class can be implicitly converted to NOTE: Some classes might not be included in the scaladoc run so they will be NoDocTemplateEntities
Classes to which this class can be implicitly converted to NOTE: Some classes might not be included in the scaladoc run so they will be NoDocTemplateEntities
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- val ownMembers: collection.immutable.List[(ModelFactory.this)#MemberImpl]
- Definition Classes
- DocTemplateImpl
- def packages: collection.immutable.List[Package]
All packages that are member of this package.
All packages that are member of this package.
- Definition Classes
- PackageImpl → Package
- 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
- def primaryConstructor: Option[(ModelFactory.this)#MemberImpl with Constructor]
The primary constructor of this class, if it has been defined.
The primary constructor of this class, if it has been defined.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- def registerImplicitlyConvertibleClass(dtpl: (ModelFactory.this)#DocTemplateImpl, conv: (ModelFactory.this)#ImplicitConversionImpl): Unit
- Definition Classes
- DocTemplateImpl
- def registerSubClass(sc: DocTemplateEntity): Unit
- Definition Classes
- DocTemplateImpl
- def reprSymbol: Global.Symbol
- Definition Classes
- PackageImpl → DocTemplateImpl
- 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
- 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
- def signature: String
The identity of this member, used for linking
The identity of this member, used for linking
- Definition Classes
- MemberImpl → MemberEntity
- lazy val signatureCompat: String
Compatibility signature, will be removed from future versions
Compatibility signature, will be removed from future versions
- Definition Classes
- MemberImpl → MemberEntity
- def sourceUrl: Option[URL]
An HTTP address at which the source of this template is available, if it is available.
An HTTP address at which the source of this template is available, if it is available. An address is available only if the
docsourceurlsetting has been set.- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- val sym: Global.Symbol
- Definition Classes
- EntityImpl
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def templates: collection.immutable.List[TemplateEntity with MemberEntity]
All templates that are members of this template.
All templates that are members of this template. If this template is a package, only templates for which documentation is available in the universe (
DocTemplateEntity) are listed.- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- def toRoot: List[(ModelFactory.this)#PackageImpl]
The package such that each is a member of the package that follows it; the first package is always this package, the last the root package.
The package such that each is a member of the package that follows it; the first package is always this package, the last the root package.
- Definition Classes
- PackageImpl → Package → DocTemplateImpl → DocTemplateEntity → MemberImpl → MemberEntity → EntityImpl → Entity
- def toString(): String
The qualified name of this entity.
The qualified name of this entity.
- Definition Classes
- Entity → AnyRef → Any
- def typeParams: collection.immutable.List[TypeParam]
The type parameters of this entity.
The type parameters of this entity.
- Definition Classes
- HigherKindedImpl → HigherKinded
- 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
- 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
- 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
- DocTemplateImpl → MemberTemplateImpl → MemberTemplateEntity
- def values: collection.immutable.List[Val]
All values, lazy values and variables that are members of this template.
All values, lazy values and variables that are members of this template.
- Definition Classes
- DocTemplateImpl → DocTemplateEntity
- 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
- 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 →[B](y: B): ((ModelFactory.this)#PackageImpl, B)
- Implicit
- This member is added by an implicit conversion from (ModelFactory.this)#PackageImpl toArrowAssoc[(ModelFactory.this)#PackageImpl] 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.