scala.reflect.internal.AnnotationInfos

AnnotationInfo

sealed abstract class AnnotationInfo extends AnnotationInfoApi

Typed information about an annotation. It can be attached to either a symbol or an annotated type.

Annotations are written to the classfile as Java annotations if atp conforms to ClassfileAnnotation (the classfile parser adds this interface to any Java annotation class).

Annotations are pickled (written to scala symtab attribute in the classfile) if atp inherits form StaticAnnotation.

args stores arguments to Scala annotations, represented as typed trees. Note that these trees are not transformed by any phases following the type-checker.

assocs stores arguments to classfile annotations as name-value pairs.

Definition Classes
AnnotationInfosAnnotationInfosAnnotationInfos
Source
AnnotationInfos.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AnnotationInfo
  2. AnnotationInfoApi
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AnnotationInfo()

Abstract Value Members

  1. abstract def args: List[Tree]

    Definition Classes
    AnnotationInfoAnnotationInfoApi
  2. abstract def assocs: List[(Name, ClassfileAnnotArg)]

    Definition Classes
    AnnotationInfoAnnotationInfoApi
  3. abstract def atp: Type

    Definition Classes
    AnnotationInfoAnnotationInfoApi
  4. abstract def original: Tree

  5. abstract def setOriginal(t: Tree): AnnotationInfo.this.type

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

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

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

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

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

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  8. def argAtIndex(index: Int): Option[Tree]

  9. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  10. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  11. def constantAtIndex(index: Int): Option[Constant]

  12. def defaultTargets: List[Symbol]

    The default kind of members to which this annotation is attached.

    The default kind of members to which this annotation is attached. For instance, for scala.deprecated defaultTargets = List(getter, setter, beanGetter, beanSetter).

  13. def ensuring(cond: (AnnotationInfo) ⇒ Boolean, msg: ⇒ Any): AnnotationInfo

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

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

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

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

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  18. def equals(other: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnnotationInfo → AnyRef → Any
  19. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  20. 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 AnnotationInfo to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  22. def hasArgWhich(p: (Tree) ⇒ Boolean): Boolean

  23. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnnotationInfo → AnyRef → Any
  24. def intArg(index: Int): Option[Int]

  25. def isErroneous: Boolean

    Check whether the type or any of the arguments are erroneous

  26. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  27. def isStatic: Boolean

  28. lazy val isTrivial: Boolean

  29. def matches(clazz: Symbol): Boolean

  30. def metaAnnotations: List[AnnotationInfo]

    These are meta-annotations attached at the use site; they only apply to this annotation usage.

    These are meta-annotations attached at the use site; they only apply to this annotation usage. For instance, in @(deprecated @setter @field) val ... metaAnnotations = List(setter, field).

  31. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  33. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  34. def pos: Position

  35. def refsSymbol(sym: Symbol): Boolean

    Check whether any of the arguments mention a symbol

  36. def setPos(pos: Position): AnnotationInfo.this.type

  37. def stringArg(index: Int): Option[String]

  38. def substIdentSyms(from: Symbol, to: Symbol): AnnotationInfo

    Change all ident's with Symbol "from" to instead use symbol "to"

  39. def symbol: Symbol

    Annotations annotating annotations are confusing so I drew an example.

    Annotations annotating annotations are confusing so I drew an example. Given the following code:

    class A {

  40. def symbolArg(index: Int): Option[TermName]

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

    Definition Classes
    AnyRef
  42. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  46. def [B](y: B): (AnnotationInfo, B)

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from AnnotationInfo to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (annotationInfo: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from AnnotationInfo to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (annotationInfo: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: AnnotationInfo

    Implicit information
    This member is added by an implicit conversion from AnnotationInfo to ArrowAssoc[AnnotationInfo] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (annotationInfo: ArrowAssoc[AnnotationInfo]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AnnotationInfo

    Implicit information
    This member is added by an implicit conversion from AnnotationInfo to Ensuring[AnnotationInfo] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (annotationInfo: Ensuring[AnnotationInfo]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnnotationInfoApi

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AnnotationInfo to StringAdd

Inherited by implicit conversion any2stringfmt from AnnotationInfo to StringFormat

Inherited by implicit conversion any2ArrowAssoc from AnnotationInfo to ArrowAssoc[AnnotationInfo]

Inherited by implicit conversion any2Ensuring from AnnotationInfo to Ensuring[AnnotationInfo]