-
- All Known Implementing Classes:
- AccessibleObject, Class, Constructor, Field, Method, Package
public interface AnnotatedElementRepresents an annotated element of the program currently running in this VM. This interface allows annotations to be read reflectively. All annotations returned by methods in this interface are immutable and serializable. It is permissible for the caller to modify the arrays returned by accessors for array-valued enum members; it will have no affect on the arrays returned to other callers.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 aTypeNotPresentException.Similarly, attempting to read an enum-valued member will result in a
EnumConstantNotPresentExceptionif 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
AnnotationTypeMismatchExceptionor anIncompleteAnnotationException.
-
-
Method Summary
Methods Modifier and Type Method and Description <T extends Annotation>
TgetAnnotation(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.Annotation[]getDeclaredAnnotations()Returns all annotations that are directly present on this element.booleanisAnnotationPresent(Class<? extends Annotation> annotationClass)Returns true if an annotation for the specified type is present on this element, else false.
-
-
-
Method Detail
-
isAnnotationPresent
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
Returns true if an annotation for the specified type is present on this element, else false. This method is designed primarily for convenient access to marker annotations.- Parameters:
annotationClass- the Class object corresponding to the annotation type- Returns:
- true if an annotation for the specified annotation type is present on this element, else false
- Throws:
NullPointerException- if the given annotation class is null- Since:
- 1.5
-
getAnnotation
<T extends Annotation> T getAnnotation(Class<T> annotationClass)
Returns this element's annotation for the specified type if such an annotation is present, else null.- Parameters:
annotationClass- the Class object corresponding to the annotation type- Returns:
- this element's annotation for the specified annotation type if present on this element, else null
- Throws:
NullPointerException- if the given annotation class is null- Since:
- 1.5
-
getAnnotations
Annotation[] getAnnotations()
Returns all annotations present on this element. (Returns an array of length zero if this element has no annotations.) The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Returns:
- all annotations present on this element
- Since:
- 1.5
-
getDeclaredAnnotations
Annotation[] getDeclaredAnnotations()
Returns all annotations that are directly present on this element. Unlike the other methods in this interface, this method ignores inherited annotations. (Returns an array of length zero if no annotations are directly present on this element.) The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Returns:
- All annotations directly present on this element
- Since:
- 1.5
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/lang/reflect/AnnotatedElement.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
