fish.payara.microprofile.openapi.impl.model.util

Class AnnotationInfo<T>

java.lang.Object

fish.payara.microprofile.openapi.impl.model.util.AnnotationInfo<T>

public final class AnnotationInfo<T>
extends Object

Represents the aggregated annotations on a type, its fields and methods including annotations "inherited" from super-classes and implemented interfaces. Should a field or method from a super-class be overridden the Annotation closest to the represented type (the overriding one) is kept.

Method Summary

Modifier and Type	Method and Description
<A extends Annotation> A	getAnnotation(Class<A> annotationType) Version of Class.getAnnotation(Class) also considering annotations "inherited" from super-types for this getType().
<A extends Annotation> A	getAnnotation(Class<A> annotationType, AnnotatedElement element) Version of AnnotatedElement.getAnnotation(Class) also considering annotations "inherited" from super-types.
<A extends Annotation> A	getAnnotation(Class<A> annotationType, Field field) Version of Field.getAnnotation(Class) also considering annotations "inherited" from overridden fields of super-types.
<A extends Annotation> A	getAnnotation(Class<A> annotationType, Method method) Version of Method.getAnnotation(Class) also considering annotations "inherited" from overridden methods of super-types.
<A extends Annotation> A	getAnnotation(Class<A> annotationType, Parameter parameter) Version of Parameter.getAnnotation(Class) also considering annotations "inherited" from overridden methods of super-types.
int	getAnnotationCount(Parameter parameter) Counts the annotation on a Parameter including those present on same parameter of an overridden method should the method be overridden.
Class<T>	getType()
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType) Version of Class.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType, AnnotatedElement element) Version of AnnotatedElement.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType, Field field) Version of AccessibleObject.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType, Method method) Version of AccessibleObject.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType, Parameter parameter) Version of AnnotatedElement.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.
boolean	isAnyAnnotationPresent(AnnotatedElement element, Class<? extends Annotation>... annotationTypes)
static <T> AnnotationInfo<T>	valueOf(Class<T> type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

valueOf

public static <T> AnnotationInfo<T> valueOf(Class<T> type)

getType

public Class<T> getType()

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Version of Class.getAnnotation(Class) also considering annotations "inherited" from super-types for this getType().

Parameters:

annotationType - annotation type to check

Returns:

the annotation of the given type if present or null otherwise

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType,
                                              Field field)

Version of Field.getAnnotation(Class) also considering annotations "inherited" from overridden fields of super-types.

Parameters:

annotationType - annotation type to check

method - must be a Field defined or inherited by this getType()

Returns:

the annotation of the given type if present or null otherwise

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType,
                                              Method method)

Version of Method.getAnnotation(Class) also considering annotations "inherited" from overridden methods of super-types.

Parameters:

annotationType - annotation type to check

method - must be a Method defined or inherited by this getType()

Returns:

the annotation of the given type if present or null otherwise

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType,
                                              Parameter parameter)

Version of Parameter.getAnnotation(Class) also considering annotations "inherited" from overridden methods of super-types.

Parameters:

annotationType - annotation type to check

parameter - must be this a Parameter of a Method defined or inherited by this getType()

Returns:

the annotation of the given type if present or null otherwise

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType,
                                              AnnotatedElement element)

Version of AnnotatedElement.getAnnotation(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

element - must be this getType()'s Class or a Field or Method defined or inherited by it or a Parameter of such a method.

Returns:

the annotation of the given type if present or null otherwise

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)

Version of Class.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

Returns:

true in case it is present at this class or any of its super-types

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType,
                                   Field field)

Version of AccessibleObject.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

Returns:

true in case it is present at the given field. The field must be defined in this getType() or any of its super-types.

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType,
                                   Method method)

Version of AccessibleObject.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

method - the method checked for annotation. The method must be defined or inherited by this getType() or any of its super-types.

Returns:

true in case it is present at the given method, else false

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType,
                                   Parameter parameter)

Version of AnnotatedElement.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

parameter - the parameter checked for annotations. The parameter must belong to a method defined or inherited by this getType()

Returns:

true in case it is present at the given parameter, else false

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType,
                                   AnnotatedElement element)

Version of AnnotatedElement.isAnnotationPresent(Class) also considering annotations "inherited" from super-types.

Parameters:

annotationType - annotation type to check

element - must be this getType()'s Class or a Field or Method defined or inherited by it or a Parameter of such a method.

Returns:

true in case it is present at the given element, else false

isAnyAnnotationPresent

@SafeVarargs
public final boolean isAnyAnnotationPresent(AnnotatedElement element,
                                                         Class<? extends Annotation>... annotationTypes)

See Also:

isAnnotationPresent(Class, AnnotatedElement)

getAnnotationCount

public int getAnnotationCount(Parameter parameter)

Counts the annotation on a Parameter including those present on same parameter of an overridden method should the method be overridden.

Parameters:

parameter - the parameter of which to count annotations for

Returns:

the number of annotation present on the given Parameter including annotations present on the same parameter of an potentially overridden method.