Scala Compiler 2.13.16 - scala.tools.nsc.doc.model.Annotation
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.model.Annotation

Scala Compiler2.13.16 < 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

# Annotation

###

#### trait Annotation extends Entity

An annotation to an entity.

Source
  Entity.scala

Linear Supertypes
Entity, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Annotation
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. Protected

### Abstract Value Members

1.  abstract def annotationClass: TemplateEntity

   The class of this annotation.

2.  abstract def annotations: List[Annotation]

   The annotations attached to this entity, if any.

   The annotations attached to this entity, if any.

   Definition Classes
     Entity
3.  abstract def arguments: List[ValueArgument]

   The arguments passed to the constructor of the annotation class.

4.  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
5.  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
6.  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
7.  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
8.  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
9.  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
10.  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 Annotation toany2stringadd[Annotation] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Annotation, B)
   Implicit
     This member is added by an implicit conversion from Annotation toArrowAssoc[Annotation] 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: (Annotation) => Boolean, msg: => Any): Annotation
   Implicit
     This member is added by an implicit conversion from Annotation toEnsuring[Annotation] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Annotation) => Boolean): Annotation
   Implicit
     This member is added by an implicit conversion from Annotation toEnsuring[Annotation] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Annotation
    Implicit
      This member is added by an implicit conversion from Annotation toEnsuring[Annotation] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Annotation
    Implicit
      This member is added by an implicit conversion from Annotation toEnsuring[Annotation] 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.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
      Annotation → Entity
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(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Annotation toStringFormat[Annotation] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

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

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromAnnotation to any2stringadd[Annotation]

### Inherited by implicit conversion StringFormat fromAnnotation to StringFormat[Annotation]

### Inherited by implicit conversion Ensuring fromAnnotation to Ensuring[Annotation]

### Inherited by implicit conversion ArrowAssoc fromAnnotation to ArrowAssoc[Annotation]

### Ungrouped