oracle.javatools.parser.java.v2.model

Interface JavaHasAnnotations

All Superinterfaces:

Element, JavaElement

All Known Subinterfaces:

CompiledSelfVariable, CompiledTmpVariable, JavaClass, JavaField, JavaIsGeneric, JavaLocalVariable, JavaMember, JavaMethod, JavaPackage, JavaType, JavaTypeVariable, JavaVariable, JavaWildcardType, SourceCatchParameter, SourceClass, SourceClassInitializer, SourceEnumConstant, SourceFieldDeclaration, SourceFieldVariable, SourceFormalParameter, SourceLambdaParameter, SourceLocalVariable, SourceMember, SourceMemberVariable, SourceMethod, SourceTypeParameter, SourceVariable

All Known Implementing Classes:

AbstractClass, AbstractField, AbstractMethod, AbstractPackage, AbstractType, AbstractVariable, BaseFileProvider.BaseClass, BaseFileProvider.BasePackage, CastedMethod, oracle.javatools.parser.java.v2.classfile.ClClass, IntersectionType, ParameterizedClass, PrimitiveType, QuickComponent, QuickJavaClass, QuickLocalVariable, QuickMethod, Value, WrapperClass, WrapperField, WrapperLocalVariable, WrapperMethod, WrapperPackage

public interface JavaHasAnnotations
extends JavaElement

All runtime annotations are provided, both visible and invisible. That is, all annotations with @Retention values of CLASS and RUNTIME are returned. Annotations with a @Retention value of SOURCE is returned only if and only if source for this element is available.

Note: @Retention values for annotations on local variables that are not formal parameters are implicitly SOURCE.

Field Summary

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

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
JavaAnnotation	getAnnotation(JavaType annotationType) Retrieves the annotation declared on this element that matches the input annotation type.
java.util.Collection<JavaAnnotation>	getAnnotations() Retrieves all the annotations declared on this element.
JavaAnnotation	getDeclaredAnnotation(JavaType annotationType)
java.util.Collection<JavaAnnotation>	getDeclaredAnnotations() Retrieves all the annotations declared on this element.
default boolean	hasAnnotation(java.lang.String annotationName) Determine if this element has declared a particular annotation.
default boolean	hasDeclaredAnnotation(java.lang.String annotationName) Determine if this element has declared a particular annotation.

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

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

Method Detail

getDeclaredAnnotations

java.util.Collection<JavaAnnotation> getDeclaredAnnotations()

Retrieves all the annotations declared on this element.

Returns:

The collection of annotations declared on this element. Returns a Collection of JavaAnnotation's.

getAnnotations

java.util.Collection<JavaAnnotation> getAnnotations()

Retrieves all the annotations declared on this element. If this element is a class, then this will also iteratively retrieve all annotations declared on this class's hierarchy.

Returns:

The collection

getDeclaredAnnotation

JavaAnnotation getDeclaredAnnotation(JavaType annotationType)

Returns:

The matching annotation declared on this element. Null if none.

getAnnotation

JavaAnnotation getAnnotation(JavaType annotationType)

Retrieves the annotation declared on this element that matches the input annotation type. If this element is a class, then this will also iteratively search for an annotation of the matching annotation type on this class's hierarchy.

Returns:

The matching annotation declared on this element or its hierarchy (if this is a class). Null if none.

hasDeclaredAnnotation

default boolean hasDeclaredAnnotation(java.lang.String annotationName)

Determine if this element has declared a particular annotation.

Parameters:

annotationName - An unqualified name, such as "Deprecated" which does a quick check that doesn't require resolutions, or a qualified name such as "java.lang.annotation.Inherited" which uses resolutions to do its check.

Returns:

True if this element has the annotation, false otherwise

hasAnnotation

default boolean hasAnnotation(java.lang.String annotationName)

Determine if this element has declared a particular annotation. If this element is a class, then this will also iteratively search for the annotation on all types of this class's hierarchy.

Parameters:

annotationName - An unqualified name, such as "Deprecated" which does a quick check that doesn't require resolutions, or a qualified name such as "java.lang.annotation.Inherited" which uses resolutions to do its check.

Returns:

True if this element, or a type in its class hierarchy, has the annotation, false otherwise