t

scala.tools.nsc.doc.model

TemplateEntity

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
Linear Supertypes
Entity, AnyRef, Any
Known Subclasses
AbstractType, AliasType, Class, DocTemplateEntity, MemberTemplateEntity, DocTemplateImpl, MemberTemplateImpl, NoDocTemplateImpl, PackageImpl, RootPackageImpl, TemplateImpl, NoDocTemplate, Object, Package, RootPackage, Trait
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TemplateEntity
  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. All

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 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
  3. 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
  4. abstract def isCaseClass: Boolean

    Whether this template is a case class.

  5. abstract def isClass: Boolean

    Whether this template is a class.

  6. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

  7. abstract def isObject: Boolean

    Whether this template is an object.

  8. abstract def isPackage: Boolean

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

  9. abstract def isRootPackage: Boolean

    Whether this template is the root package.

  10. abstract def isTrait: Boolean

    Whether this template is a trait.

  11. 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
  12. abstract def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
    Entity
  13. 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
  14. 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
  15. abstract def selfType: Option[TypeEntity]

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

  16. 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
  17. 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

  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 TemplateEntity to any2stringadd[TemplateEntity] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TemplateEntity, B)
    Implicit
    This member is added by an implicit conversion from TemplateEntity to ArrowAssoc[TemplateEntity] 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( ... ) @native()
  8. def ensuring(cond: (TemplateEntity) ⇒ Boolean, msg: ⇒ Any): TemplateEntity
    Implicit
    This member is added by an implicit conversion from TemplateEntity to Ensuring[TemplateEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TemplateEntity) ⇒ Boolean): TemplateEntity
    Implicit
    This member is added by an implicit conversion from TemplateEntity to Ensuring[TemplateEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): TemplateEntity
    Implicit
    This member is added by an implicit conversion from TemplateEntity to Ensuring[TemplateEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TemplateEntity
    Implicit
    This member is added by an implicit conversion from TemplateEntity to Ensuring[TemplateEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TemplateEntity to StringFormat[TemplateEntity] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): java.lang.Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def →[B](y: B): (TemplateEntity, B)
    Implicit
    This member is added by an implicit conversion from TemplateEntity to ArrowAssoc[TemplateEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Entity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TemplateEntity to any2stringadd[TemplateEntity]

Inherited by implicit conversion StringFormat from TemplateEntity to StringFormat[TemplateEntity]

Inherited by implicit conversion Ensuring from TemplateEntity to Ensuring[TemplateEntity]

Inherited by implicit conversion ArrowAssoc from TemplateEntity to ArrowAssoc[TemplateEntity]

Ungrouped