In the definitions below, an annotation A has an annotation interface AI. If AI is a repeatable annotation interface, the type of the container annotation is AIC.
Annotation A is directly present on a construct C if either:
Typically, if exactly one annotation of type AI appears in the source code of representation of C, then A is explicitly declared as applying to C. An annotation of type AI on a record component can be implicitly propagated down to affiliated mandated members. Type annotations modifying the type of a record component can be also propagated to mandated members. Propagation of the annotations to mandated members is governed by rules given in the The Java Language Specification (JLS 8.10.1). If there are multiple annotations of type AI present on C, then if AI is a repeatable annotation interface, an annotation of type AIC is implicitly declared on C.
RuntimeVisibleAnnotations (JVMS 4.7.16) or
RuntimeVisibleParameterAnnotations (JVMS 4.7.17) attributes of a class
file.
An annotation A is present on a construct C if either:
value method of the directly present annotation
of type AIC.
@Inherited, 9.7.4 Where Annotations May Appear, 9.7.5 Multiple Annotations of the Same Interface
| Modifier and Type | Method and Description |
|---|---|
| public < the annotation interface A extends Annotation> A | Returns: this construct's annotation of the specified type if such an annotation is present, elsenullthe annotationType)Class object corresponding to
the annotation interfaceReturns this construct's annotation of the specified type if
such an annotation is present, else |
| public List | Returns: the annotations directly present on this construct; an empty list if there are noneReturns the annotations that are directly present on this construct. |
| public < the annotation interface A extends Annotation> A[] | Returns: this construct's annotations for the specified annotation type if present on this construct, else an empty arraythe annotationType)Class object corresponding to
the annotation interfaceReturns annotations of the specified type that are associated with this construct. |
| getAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getAnnotation(Class<A> annotationType) Returns this construct's annotation of the specified type if
such an annotation is present, else The annotation returned by this method could contain an element
whose value is of type Note This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation interfaces currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation interfaces.
| |
| getAnnotationMirrors | back to summary |
|---|---|
| public List Returns the annotations that are directly present on this construct.
| |
| getAnnotationsByType | back to summary |
|---|---|
| public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType) Returns annotations of the specified type that are associated
with this construct.
If there are no annotations of the specified type associated with this
construct, the return value is an array of length 0.
The order of annotations which are directly or indirectly
present on a construct C is computed as if indirectly present
annotations on C are directly present on C in place of their
container annotation, in the order in which they appear in the
value element of the container annotation.
The difference between this method and The annotations returned by this method could contain an element
whose value is of type Note This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation interfaces currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation interfaces.
| |