public interface AnnotatedElement
If an annotation returned by a method in this interface contains
(directly or indirectly) a Class
-valued member referring to
a class that is not accessible in this VM, attempting to read the class
by calling the relevant Class-returning method on the returned annotation
will result in a TypeNotPresentException
.
Similarly, attempting to read an enum-valued member will result in
a EnumConstantNotPresentException
if the enum constant in the
annotation is no longer present in the enum type.
Finally, Attempting to read a member whose definition has evolved
incompatibly will result in a AnnotationTypeMismatchException
or an
IncompleteAnnotationException
.
Modifier and Type | Method and Description |
---|---|
<T extends Annotation> |
getAnnotation(Class<T> annotationClass)
Returns this element's annotation for the specified type if
such an annotation is present, else null.
|
Annotation[] |
getAnnotations()
Returns all annotations present on this element.
|
default <T extends Annotation> |
getAnnotationsByType(Class<T> annotationClass)
Returns an associated list of annotations on
this element,
whose class is annotationClass , or an empty array if nothing was found. |
default <T extends Annotation> |
getDeclaredAnnotation(Class<T> annotationClass)
Returns a directly-present annotation on
this element, whose class is
annotationClass , or null if nothing was found. |
Annotation[] |
getDeclaredAnnotations()
Returns all annotations that are directly present on this
element.
|
default <T extends Annotation> |
getDeclaredAnnotationsByType(Class<T> annotationClass)
Returns a directly or indirectly present list of annotations on
this element,
whose class is annotationClass , or an empty array if nothing was found. |
default boolean |
isAnnotationPresent(Class<? extends Annotation> annotationClass)
Returns true if an annotation for the specified type
is present on this element, else false.
|
default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
annotationClass
- the Class object corresponding to the
annotation typeNullPointerException
- if the given annotation class is null<T extends Annotation> T getAnnotation(Class<T> annotationClass)
annotationClass
- the Class object corresponding to the
annotation typeNullPointerException
- if the given annotation class is nullAnnotation[] getAnnotations()
Annotation[] getDeclaredAnnotations()
default <T extends Annotation> Annotation getDeclaredAnnotation(Class<T> annotationClass)
this
element, whose class is
annotationClass
, or null
if nothing was found.default <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)
this
element,
whose class is annotationClass
, or an empty array if nothing was found.default <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
this
element,
whose class is annotationClass
, or an empty array if nothing was found.