Scala Compiler2.13.1 < 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
-  package diagram
  Definition Classes
    model
- AbstractType
- AliasType
- Annotation
- AnnotationClass
- BoundedTypeParamConstraint
- Class
- CommentFactory
- Constraint
- Constructor
- Def
- DocTemplateEntity
- Entity
- EqualTypeParamConstraint
- HigherKinded
- ImplicitConversion
- ImplicitInScopeConstraint
- ImplicitMemberShadowing
- IndexModelFactory
- KnownTypeClassConstraint
- LowerBoundedTypeParamConstraint
- MemberEntity
- MemberLookup
- MemberTemplateEntity
- ModelFactory
- ModelFactoryImplicitSupport
- ModelFactoryTypeSupport
- NoDocTemplate
- NonTemplateMemberEntity
- Object
- Package
- ParameterEntity
- PrivateInInstance
- PrivateInTemplate
- ProtectedInInstance
- ProtectedInTemplate
- Public
- RootPackage
- TemplateEntity
- Trait
- TreeEntity
- TreeFactory
- TypeClassConstraint
- TypeEntity
- TypeParam
- TypeParamConstraint
- UpperBoundedTypeParamConstraint
- Val
- ValueArgument
- ValueParam
- Visibility

t

scala.tools.nsc.doc.model

# AnnotationClass

###

#### trait AnnotationClass extends Class

An annotation template. Any class which extends `scala.annotation.Annotation`

Source
  Entity.scala

Linear Supertypes
Class, MemberTemplateEntity, HigherKinded, MemberEntity, TemplateEntity, Entity, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AnnotationClass
2. Class
3. MemberTemplateEntity
4. HigherKinded
5. MemberEntity
6. TemplateEntity
7. Entity
8. AnyRef
9. 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

### 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 byConversion: Option[ImplicitConversion]

   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
     MemberEntity
3.  abstract def comment: Option[Comment]

   The comment attached to this member, if any.

   The comment attached to this member, if any.

   Definition Classes
     MemberEntity
4.  abstract def 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
     MemberEntity
5.  abstract 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
     MemberEntity
6.  abstract def flags: 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
     MemberEntity
7.  abstract def group: String

   The group this member is from

   The group this member is from

   Definition Classes
     MemberEntity
8.  abstract 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
     MemberEntity
9.  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
10.  abstract def inTemplate: DocTemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
      MemberEntity → Entity
11.  abstract def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
      MemberEntity
12.  abstract def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
      MemberEntity
13.  abstract def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
      MemberEntity
14.  abstract 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
      MemberEntity
15.  abstract def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
      TemplateEntity
16.  abstract def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
      TemplateEntity
17.  abstract def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
      MemberEntity
18.  abstract def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
      MemberEntity
19.  abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
      TemplateEntity
20.  abstract def isImplicitlyInherited: Boolean

    Indicates whether the member is inherited by implicit conversion

    Indicates whether the member is inherited by implicit conversion

    Definition Classes
      MemberEntity
21.  abstract def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
      MemberEntity
22.  abstract def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
      TemplateEntity
23.  abstract 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
      TemplateEntity
24.  abstract def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
      TemplateEntity
25.  abstract 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
      MemberEntity
26.  abstract 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
      MemberEntity
27.  abstract def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
      TemplateEntity
28.  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
29.  abstract 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
      MemberEntity
30.  abstract def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
      MemberEntity
31.  abstract 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
      MemberEntity
32.  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
33.  abstract def parentTypes: List[(TemplateEntity, TypeEntity)]

    The direct super-type of this template e.g:

    The direct super-type of this template e.g:

        class A extends B[C[Int]] with D[E]

    will have two direct parents: class B and D NOTE: we are dropping the refinement here! class A extends B[C[Int]] with D[E] }}} NOTE: we are dropping the refinement here!

    Definition Classes
      MemberTemplateEntity
34.  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
35.  abstract 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
      MemberEntity
36.  abstract 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
      TemplateEntity
37.  abstract def signature: String

    The identity of this member, used for linking

    The identity of this member, used for linking

    Definition Classes
      MemberEntity
38.  abstract def signatureCompat: String

    Compatibility signature, will be removed from future versions

    Compatibility signature, will be removed from future versions

    Definition Classes
      MemberEntity
39.  abstract def toRoot: List[MemberEntity]

    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
      MemberEntity → Entity
40.  abstract def typeParams: List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
      HigherKinded
41.  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
42.  abstract def useCaseOf: Option[MemberEntity]

    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
      MemberEntity
43.  abstract 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
      MemberTemplateEntity
44.  abstract 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
      MemberEntity

### 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 AnnotationClass toany2stringadd[AnnotationClass] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (AnnotationClass, B)
   Implicit
     This member is added by an implicit conversion from AnnotationClass toArrowAssoc[AnnotationClass] 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(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (AnnotationClass) => Boolean, msg: => Any): AnnotationClass
   Implicit
     This member is added by an implicit conversion from AnnotationClass toEnsuring[AnnotationClass] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (AnnotationClass) => Boolean): AnnotationClass
   Implicit
     This member is added by an implicit conversion from AnnotationClass toEnsuring[AnnotationClass] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): AnnotationClass
    Implicit
      This member is added by an implicit conversion from AnnotationClass toEnsuring[AnnotationClass] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): AnnotationClass
    Implicit
      This member is added by an implicit conversion from AnnotationClass toEnsuring[AnnotationClass] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): 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 AnnotationClass toStringFormat[AnnotationClass] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
16.  final def getClass(): java.lang.Class[_ <: AnyRef]
    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.  def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
      AnnotationClass → Class → Entity
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
24.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
      Entity → AnyRef → Any
25.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
27.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def →[B](y: B): (AnnotationClass, B)
   Implicit
     This member is added by an implicit conversion from AnnotationClass toArrowAssoc[AnnotationClass] 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 Class

### Inherited from MemberTemplateEntity

### Inherited from HigherKinded

### Inherited from MemberEntity

### Inherited from TemplateEntity

### Inherited from Entity

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromAnnotationClass to any2stringadd[AnnotationClass]

### Inherited by implicit conversion StringFormat fromAnnotationClass to StringFormat[AnnotationClass]

### Inherited by implicit conversion Ensuring fromAnnotationClass to Ensuring[AnnotationClass]

### Inherited by implicit conversion ArrowAssoc fromAnnotationClass to ArrowAssoc[AnnotationClass]

### Ungrouped