oracle.javatools.parser.java.v2.model

Interface JavaAnnotation

All Superinterfaces:

Element, JavaElement, JavaHasType

All Known Subinterfaces:

SourceAnnotation

All Known Implementing Classes:

AbstractAnnotation

public interface JavaAnnotation
extends JavaElement, JavaHasType

An instance of an annotation type.

Field Summary

Fields

Modifier and Type	Field and Description
static JavaAnnotation[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
JavaType	getAnnotationType() Equivalent to getResolvedType().
java.util.Map<java.lang.String,java.lang.Object>	getArguments() Get the arguments used to instantiate the annotation.
java.util.Map<java.lang.String,java.lang.Object>	getComponents() Here, "component" is not equivalent to "argument".
SourceAnnotation	getSourceElement()
java.util.Map<java.lang.String,java.lang.Object>	getUnresolvedArguments() Get the arguments used to instantiate the annotation, but don't try to resolve any types.
boolean	isInherited()

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasType

getResolvedType, getUnresolvedType

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaElement

getElementKind, getFile, getModifiers, getOwner, isDeprecated, isFinal, isHidden, isSourceElement, isSynthetic, printCompiledInfo

Field Detail

EMPTY_ARRAY

static final JavaAnnotation[] EMPTY_ARRAY

Method Detail

isInherited

boolean isInherited()

Returns:

True if this annotation bears the meta-annotation java/lang/annotation/Inherited.

getArguments

java.util.Map<java.lang.String,java.lang.Object> getArguments()

Get the arguments used to instantiate the annotation.

Returns:

The map of arguments. Keys are Strings for the argument name. Values are Objects and the types of those Objects are one of the following: A primitive Object such as Byte, Character, Short, Integer, Long, Double, Float OR a String Object OR a JavaField representing an Enum constant OR a JavaAnnotation, OR a JavaType representing a class literal, OR an array of any of the already mentioned types.

getUnresolvedArguments

java.util.Map<java.lang.String,java.lang.Object> getUnresolvedArguments()

Get the arguments used to instantiate the annotation, but don't try to resolve any types. This is useful for situations where no JavaProvider is available to do type resolution

Returns:

The map of arguments. Keys are Strings for the argument name. Values are Objects. For the types of the Objects, please see getArguments(), but any JavaTypes are now returned as JavaHasTypes, and enum values are returned as JavaHasName.

getComponents

java.util.Map<java.lang.String,java.lang.Object> getComponents()

Here, "component" is not equivalent to "argument". A component is a declared member of an annotation type. An annotation can be instantiated with fewer arguments than components.

Consider:

    @Retention( RetentionPolicy.RUNTIME )
    @interface Annotate
   {
     public int b() default 1;
   }

    @Annotate()
   class C
   {
   }
 

Here, @Annotate() has zero arguments. Similarly, C.class will show that @Annotate() has zero arguments.

Returns:

The map of components. Keys are Strings for the component name. In the above case the key would be "b". Values are Objects. For the types of the Objects, please see getArguments().

getAnnotationType

JavaType getAnnotationType()

Equivalent to getResolvedType(). Provided to correspond with java/lang/annotation/Annotation.annotationType().

Returns:

The resolved annotation type that this annotation is an instance of.

getSourceElement

SourceAnnotation getSourceElement()

Specified by:

getSourceElement in interface JavaElement

Returns:

The corresponding source symbol to this element. Null if there is no corresponding source symbol or if the corresponding source symbol could not be found.