scala.reflect.api

Annotations

trait Annotations extends AnyRef

EXPERIMENTAL

This trait provides annotation support for the reflection API.

The API distinguishes between two kinds of annotations:

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:

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

Self Type
Universe
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Annotations
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Annotation >: Null <: Universe.AnnotationApi

    Information about an annotation.

  2. trait AnnotationApi extends AnyRef

    The API of Annotation instances.

  3. abstract class AnnotationExtractor extends AnyRef

    An extractor class to create and pattern match with syntax Annotation(tpe, scalaArgs, javaArgs).

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

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

  5. trait ArrayArgumentApi extends AnyRef

    API of ArrayArgument instances.

  6. abstract class ArrayArgumentExtractor extends AnyRef

    An extractor class to create and pattern match with syntax ArrayArgument(args) where args is the argument array.

  7. abstract type JavaArgument >: Null <: AnyRef

    A Java annotation argument

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

  9. trait LiteralArgumentApi extends AnyRef

    The API of LiteralArgument instances.

  10. abstract class LiteralArgumentExtractor extends AnyRef

    An extractor class to create and pattern match with syntax LiteralArgument(value) where value is the constant argument.

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

    A nested annotation argument to a Java annotation as @Nested in @Outer(@Nested).

  12. trait NestedArgumentApi extends AnyRef

    API of NestedArgument instances.

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

  1. abstract val Annotation: Universe.AnnotationExtractor

    The constructor/extractor for Annotation instances.

  2. abstract val ArrayArgument: Universe.ArrayArgumentExtractor

    The constructor/extractor for ArrayArgument instances.

  3. abstract val LiteralArgument: Universe.LiteralArgumentExtractor

    The constructor/extractor for LiteralArgument instances.

  4. abstract val NestedArgument: Universe.NestedArgumentExtractor

    The constructor/extractor for NestedArgument instances.

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 Annotations to StringAdd[Annotations] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd
  5. 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()
  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: (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
  11. 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
  12. 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
  13. 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
  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 Annotations to StringFormat[Annotations] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): 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

    Definition Classes
    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): (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]

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.

Ungrouped