Scala Reflection Library2.12.18 < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package reflect
  Definition Classes
    scala
-  package api

  EXPERIMENTAL

  EXPERIMENTAL

  The Scala Reflection API (located in scala-reflect.jar).

  In Scala 2.10.0, the Scala Reflection API and its implementation have an "experimental" status. This means that the API and the docs are not complete and can be changed in binary- and source-incompatible manner in 2.10.1. This also means that the implementation has some known issues.

  The following types are the backbone of the Scala Reflection API, and serve as a good starting point for information about Scala Reflection:

  - scala.reflect.api.Symbols
  - scala.reflect.api.Types
  - scala.reflect.api.Mirrors
  - scala.reflect.api.Universe

  For more information about Scala Reflection, see the Reflection Guide

  Definition Classes
    reflect
-  trait Annotations extends AnyRef

  EXPERIMENTAL

  EXPERIMENTAL

  This trait provides annotation support for the reflection API.

  In Scala, annotations belong to one of the two categories:

  - 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 superclass to every Java annotation type.
  - 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.

  Both Java and Scala annotations are represented as typed trees carrying constructor invocations corresponding to the annotation. For instance, the annotation in `@ann(1, 2) class C` is represented as `q"@new ann(1, 2)"`.

  Unlike Java reflection, Scala reflection does not support evaluation of constructor invocations stored in annotations into underlying objects. For instance it's impossible to go from `@ann(1, 2) class C` to `ann(1, 2)`, so one has to analyze trees representing annotation arguments to manually extract corresponding values. Towards that end, arguments of an annotation can be obtained via `annotation.tree.children.tail`.

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

  Definition Classes
    api
- Annotation
- AnnotationApi
- AnnotationExtractor
- ArrayArgument
- ArrayArgumentApi
- ArrayArgumentExtractor
- JavaArgument
- JavaArgumentApi
- LiteralArgument
- LiteralArgumentApi
- LiteralArgumentExtractor
- NestedArgument
- NestedArgumentApi
- NestedArgumentExtractor

a

scala.reflect.api.Annotations

# Annotation 

###
Companion class AnnotationExtractor

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

Information about an annotation.

Source
  Annotations.scala

Linear Supertypes
Universe.AnnotationApi, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Annotation
2. AnnotationApi
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def javaArgs: ListMap[Universe.Name, Universe.JavaArgument]

   Payload of the Java annotation: a list of name-value pairs.

   Payload of the Java annotation: a list of name-value pairs. Empty for Scala annotations.

   Definition Classes
     AnnotationApi
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use `tree.children.tail` instead

2.  abstract def scalaArgs: List[Universe.Tree]

   Payload of the Scala annotation: a list of abstract syntax trees that represent the argument.

   Payload of the Scala annotation: a list of abstract syntax trees that represent the argument. Empty for Java annotations.

   Definition Classes
     AnnotationApi
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use `tree.children.tail` instead

3.  abstract def tpe: Universe.Type

   The type of the annotation.

   The type of the annotation.

   Definition Classes
     AnnotationApi
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use `tree.tpe` instead

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... ) @native()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  def tree: Universe.Tree

    The tree underlying the annotation.

    The tree underlying the annotation.

    Definition Classes
      AnnotationApi
18.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
20.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()

### Inherited from Universe.AnnotationApi

### Inherited from AnyRef

### Inherited from Any

### Ungrouped