trait TemplateEntity extends Entity
A template, which is either a class, trait, object or package. Depending on whether documentation is available or not, the template will be modeled as a [scala.tools.nsc.doc.model.NoDocTemplate] or a [scala.tools.nsc.doc.model.DocTemplateEntity].
- Source
- Entity.scala
- Alphabetic
- By Inheritance
- TemplateEntity
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 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: TemplateEntity
The template of which this entity is a member.
The template of which this entity is a member.
- Definition Classes
- Entity
- abstract def isCase: Boolean
Whether this template is a case class or a case object.
- abstract def isClass: Boolean
Whether this template is a class.
- abstract def isDocTemplate: Boolean
Whether documentation is available for this template.
- abstract def isObject: Boolean
Whether this template is an object.
- abstract def isPackage: Boolean
Whether this template is a package (including the root package).
- abstract def isRootPackage: Boolean
Whether this template is the root package.
- abstract def isTrait: Boolean
Whether this template is a trait.
- 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 kind: String
The kind of the entity
The kind of the entity
- Definition Classes
- Entity
- 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
qualifiedNameinstead.- 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 selfType: Option[TypeEntity]
The self-type of this template, if it differs from the template type.
- abstract def toRoot: List[Entity]
The list of entities such that each is a member of the entity that follows it; the first entity is always this entity, 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 entity, the last the root package entity.
- Definition Classes
- 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
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 TemplateEntity toany2stringadd[TemplateEntity] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TemplateEntity, B)
- Implicit
- This member is added by an implicit conversion from TemplateEntity toArrowAssoc[TemplateEntity] 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (TemplateEntity) => Boolean, msg: => Any): TemplateEntity
- Implicit
- This member is added by an implicit conversion from TemplateEntity toEnsuring[TemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TemplateEntity) => Boolean): TemplateEntity
- Implicit
- This member is added by an implicit conversion from TemplateEntity toEnsuring[TemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TemplateEntity
- Implicit
- This member is added by an implicit conversion from TemplateEntity toEnsuring[TemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TemplateEntity
- Implicit
- This member is added by an implicit conversion from TemplateEntity toEnsuring[TemplateEntity] 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): java.lang.Class[_ <: AnyRef]
- 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(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 formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from TemplateEntity toStringFormat[TemplateEntity] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (TemplateEntity, B)
- Implicit
- This member is added by an implicit conversion from TemplateEntity toArrowAssoc[TemplateEntity] 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.