net.florianschoppmann.java.type

Interface AnnotatedConstruct

All Known Subinterfaces:

IntersectionType

public interface AnnotatedConstruct

Represents a construct that can be annotated, equivalent to javax.lang.model.AnnotatedConstruct in JDK 8.

This interface's sole purpose is to ensure source compatibility with Java 7 and 8, despite the fact that javax.lang.model.AnnotatedConstruct was retrofitted into the Java language model hierarchy in JDK 8. See the JDK 8 JavaDoc for javax.lang.model.AnnotatedConstruct for more information.

Implementations may implement both javax.lang.model.AnnotatedConstruct and this interface. At some time in the future, when Java 7 compatibility is no longer required, this interface will be deprecated and eventually removed in favor of javax.lang.model.AnnotatedConstruct.

Method Summary

Modifier and Type	Method and Description
<A extends Annotation> A	getAnnotation(Class<A> annotationType) Returns this construct's annotation of the specified type if such an annotation is present, else null.
List<? extends AnnotationMirror>	getAnnotationMirrors() Returns the annotations that are directly present on this construct.
<A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType) Returns annotations that are associated with this construct.

Method Detail

getAnnotationMirrors

List<? extends AnnotationMirror> getAnnotationMirrors()

Returns the annotations that are directly present on this construct.

Returns:

the annotations directly present on this construct; an empty list if there are none

getAnnotation

@Nullable
<A extends Annotation> A getAnnotation(Class<A> annotationType)

Returns this construct's annotation of the specified type if such an annotation is present, else null.

Type Parameters:

A - the annotation type

Parameters:

annotationType - the Class object corresponding to the annotation type

Returns:

this construct's annotation for the specified annotation type if present, else null

getAnnotationsByType

<A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)

Returns annotations that are associated with this construct.

Type Parameters:

A - the annotation type

Parameters:

annotationType - the Class object corresponding to the annotation type

Returns:

this construct's annotations for the specified annotation type if present on this construct, else an empty array