Annotations

EXPERIMENTAL

This trait provides annotation support for the reflection API.

The API distinguishes between two kinds of annotations:

Java annotations: annotations on definitions produced by the Java compiler, i.e., subtypes of java.lang.annotation.Annotation attached to program definitions. When read by Scala reflection, the scala.annotation.ClassfileAnnotation trait is automatically added as a subclass to every Java annotation.
Scala annotations: annotations on definitions or types produced by the Scala compiler.

When a Scala annotation that inherits from scala.annotation.StaticAnnotation or scala.annotation.ClassfileAnnotation is compiled, it is stored as special attributes in the corresponding classfile, and not as a Java annotation. Note that subclassing just scala.annotation.Annotation is not enough to have the corresponding metadata persisted for runtime reflection.

The distinction between Java and Scala annotations is manifested in the contract of scala.reflect.api.Annotations#Annotation, which exposes both scalaArgs and javaArgs. For Scala or Java annotations extending scala.annotation.ClassfileAnnotation scalaArgs is empty and arguments are stored in javaArgs. For all other Scala annotations, arguments are stored in scalaArgs and javaArgs is empty.

Arguments in scalaArgs are represented as typed trees. Note that these trees are not transformed by any phases following the type-checker. Arguments in javaArgs are repesented as a map from scala.reflect.api.Names#Name to scala.reflect.api.Annotations#JavaArgument. Instances of JavaArgument represent different kinds of Java annotation arguments:

literals (primitive and string constants),
arrays and
nested annotations.

For more information about Annotations, see the Reflection Guide: Annotations, Names, Scopes, and More

Self Type: Universe
Source: Annotations.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

JavaUniverse, JavaUniverse, Universe, Universe

Type Hierarchy Learn more about scaladoc diagrams

Content Hierarchy Learn more about scaladoc diagrams

Type Members

abstract type Annotation >: Null <: Universe.AnnotationApi

Information about an annotation.
trait AnnotationApi extends AnyRef

The API of Annotation instances.
abstract class AnnotationExtractor extends AnyRef

An extractor class to create and pattern match with syntax Annotation(tpe, scalaArgs, javaArgs).
abstract type ArrayArgument >: Null <: Universe.JavaArgument with Universe.ArrayArgumentApi

An array argument to a Java annotation as in @Target(value={TYPE,FIELD,METHOD,PARAMETER})
trait ArrayArgumentApi extends AnyRef

API of ArrayArgument instances.
abstract class ArrayArgumentExtractor extends AnyRef

An extractor class to create and pattern match with syntax ArrayArgument(args) where args is the argument array.
abstract type JavaArgument >: Null <: AnyRef

A Java annotation argument
abstract type LiteralArgument >: Null <: Universe.JavaArgument with Universe.LiteralArgumentApi

A literal argument to a Java annotation as "Use X instead" in @Deprecated("Use X instead")
trait LiteralArgumentApi extends AnyRef

The API of LiteralArgument instances.
abstract class LiteralArgumentExtractor extends AnyRef

An extractor class to create and pattern match with syntax LiteralArgument(value) where value is the constant argument.
abstract type NestedArgument >: Null <: Universe.JavaArgument with Universe.NestedArgumentApi

A nested annotation argument to a Java annotation as @Nested in @Outer(@Nested).
trait NestedArgumentApi extends AnyRef

API of NestedArgument instances.
abstract class NestedArgumentExtractor extends AnyRef

An extractor class to create and pattern match with syntax NestedArgument(annotation) where annotation is the nested annotation.

Abstract Value Members

abstract val Annotation: Universe.AnnotationExtractor

The constructor/extractor for Annotation instances.
implicit abstract val AnnotationTag: ClassTag[Universe.Annotation]

A tag that preserves the identity of the Annotation abstract type from erasure.
A tag that preserves the identity of the Annotation abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.
abstract val ArrayArgument: Universe.ArrayArgumentExtractor

The constructor/extractor for ArrayArgument instances.
implicit abstract val ArrayArgumentTag: ClassTag[Universe.ArrayArgument]

A tag that preserves the identity of the ArrayArgument abstract type from erasure.
A tag that preserves the identity of the ArrayArgument abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.
implicit abstract val JavaArgumentTag: ClassTag[Universe.JavaArgument]

A tag that preserves the identity of the JavaArgument abstract type from erasure.
A tag that preserves the identity of the JavaArgument abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.
abstract val LiteralArgument: Universe.LiteralArgumentExtractor

The constructor/extractor for LiteralArgument instances.
implicit abstract val LiteralArgumentTag: ClassTag[Universe.LiteralArgument]

A tag that preserves the identity of the LiteralArgument abstract type from erasure.
A tag that preserves the identity of the LiteralArgument abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.
abstract val NestedArgument: Universe.NestedArgumentExtractor

The constructor/extractor for NestedArgument instances.
implicit abstract val NestedArgumentTag: ClassTag[Universe.NestedArgument]

A tag that preserves the identity of the NestedArgument abstract type from erasure.
A tag that preserves the identity of the NestedArgument abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Annotations to StringAdd[Annotations] performed by method StringAdd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (Annotations, B)

Implicit information
This member is added by an implicit conversion from Annotations to ArrowAssoc[Annotations] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def ensuring(cond: (Annotations) ⇒ Boolean, msg: ⇒ Any): Annotations

Implicit information
This member is added by an implicit conversion from Annotations to Ensuring[Annotations] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Annotations) ⇒ Boolean): Annotations

Implicit information
This member is added by an implicit conversion from Annotations to Ensuring[Annotations] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Annotations

Implicit information
This member is added by an implicit conversion from Annotations to Ensuring[Annotations] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Annotations

Implicit information
This member is added by an implicit conversion from Annotations to Ensuring[Annotations] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def formatted(fmtstr: String): String

Returns string formatted according to given format string.
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit information
This member is added by an implicit conversion from Annotations to StringFormat[Annotations] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def →[B](y: B): (Annotations, B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Annotations to StringAdd[Annotations]

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

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

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

API

The methods available for each reflection entity, without the implementation. Since the reflection entities are later overridden by runtime reflection and macros, their API counterparts guarantee a minimum set of methods that are implemented.

Extractors

Extractors provide the machinery necessary to allow pattern matching and construction of reflection entities that is similar to case classes, although the entities are only abstract types that are later overridden.

Annotations

trait Annotations extends AnyRef

Type Members

abstract type Annotation >: Null <: Universe.AnnotationApi

trait AnnotationApi extends AnyRef

abstract class AnnotationExtractor extends AnyRef

abstract type ArrayArgument >: Null <: Universe.JavaArgument with Universe.ArrayArgumentApi

trait ArrayArgumentApi extends AnyRef

abstract class ArrayArgumentExtractor extends AnyRef

abstract type JavaArgument >: Null <: AnyRef

abstract type LiteralArgument >: Null <: Universe.JavaArgument with Universe.LiteralArgumentApi

trait LiteralArgumentApi extends AnyRef

abstract class LiteralArgumentExtractor extends AnyRef

abstract type NestedArgument >: Null <: Universe.JavaArgument with Universe.NestedArgumentApi

trait NestedArgumentApi extends AnyRef

abstract class NestedArgumentExtractor extends AnyRef

Abstract Value Members

abstract val Annotation: Universe.AnnotationExtractor

implicit abstract val AnnotationTag: ClassTag[Universe.Annotation]

abstract val ArrayArgument: Universe.ArrayArgumentExtractor

implicit abstract val ArrayArgumentTag: ClassTag[Universe.ArrayArgument]

implicit abstract val JavaArgumentTag: ClassTag[Universe.JavaArgument]

abstract val LiteralArgument: Universe.LiteralArgumentExtractor

implicit abstract val LiteralArgumentTag: ClassTag[Universe.LiteralArgument]

abstract val NestedArgument: Universe.NestedArgumentExtractor

implicit abstract val NestedArgumentTag: ClassTag[Universe.NestedArgument]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Annotations, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Annotations) ⇒ Boolean, msg: ⇒ Any): Annotations

def ensuring(cond: (Annotations) ⇒ Boolean): Annotations

def ensuring(cond: Boolean, msg: ⇒ Any): Annotations

def ensuring(cond: Boolean): Annotations

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Annotations, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Annotations to StringAdd[Annotations]

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

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

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

Annotations

API

Extractors

Tags

Ungrouped