scala.tools.nsc.doc.model

Entity

trait Entity extends AnyRef

An entity in a Scaladoc universe. Entities are declarations in the program and correspond to symbols in the compiler. Entities model the following Scala concepts:

Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractType, AliasType, Annotation, Class, Constructor, Def, DocTemplateEntity, DocTemplateImpl, EntityImpl, MemberEntity, MemberImpl, MemberTemplateEntity, MemberTemplateImpl, NoDocTemplate, NoDocTemplateImpl, NonTemplateMemberEntity, NonTemplateMemberImpl, NonTemplateParamMemberImpl, Object, Package, PackageImpl, RootPackage, RootPackageImpl, TemplateEntity, TemplateImpl, Trait, Val
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Entity
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def annotations: List[Annotation]

    The annotations attached to this entity, if any.

  2. abstract def id: Int

    Similar to symbols, so we can track entities

  3. abstract def inPackageObject: Boolean

    Whether or not the template was defined in a package object

  4. abstract def inTemplate: TemplateEntity

    The template of which this entity is a member.

  5. abstract def isTerm: Boolean

    Indicates whether this entity lives in the terms namespace (objects, packages, methods, values)

  6. abstract def isType: Boolean

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

  7. abstract def kind: String

    The kind of the entity

  8. 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.

  9. 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.

  10. 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.

  11. abstract def universe: Universe

    The Scaladoc universe of which this entity is a member.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Entity to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Entity, B)

    Implicit information
    This member is added by an implicit conversion from Entity to ArrowAssoc[Entity] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (Entity) ⇒ Boolean, msg: ⇒ Any): Entity

    Implicit information
    This member is added by an implicit conversion from Entity to Ensuring[Entity] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Entity) ⇒ Boolean): Entity

    Implicit information
    This member is added by an implicit conversion from Entity to Ensuring[Entity] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Entity

    Implicit information
    This member is added by an implicit conversion from Entity to Ensuring[Entity] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Entity

    Implicit information
    This member is added by an implicit conversion from Entity to Ensuring[Entity] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Entity to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  25. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (Entity, B)

    Implicit information
    This member is added by an implicit conversion from Entity to ArrowAssoc[Entity] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Entity to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (entity: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Entity to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (entity: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Entity

    Implicit information
    This member is added by an implicit conversion from Entity to ArrowAssoc[Entity] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (entity: ArrowAssoc[Entity]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Entity

    Implicit information
    This member is added by an implicit conversion from Entity to Ensuring[Entity] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (entity: Ensuring[Entity]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Entity to StringAdd

Inherited by implicit conversion any2stringfmt from Entity to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Entity to ArrowAssoc[Entity]

Inherited by implicit conversion any2Ensuring from Entity to Ensuring[Entity]

Ungrouped