io.micronaut.core.annotation

Interface AnnotationMetadata

All Superinterfaces:

AnnotationSource

All Known Subinterfaces:

AnnotationElement, AnnotationMetadataDelegate, ArrayableClassElement, BeanConstructorElement, BeanDefinition<T>, BeanDefinitionMethodReference<T,R>, BeanElement, BeanElementBuilder, BeanFieldElement, BeanIntrospection<T>, BeanMethodElement, BeanParameterElement, BeanProperty<B,T>, ClassElement, ConfigurableElement, ConstructorElement, ConstructorInvocationContext<T>, DelegatingBeanDefinition<T>, DelegatingExecutableMethod<T,R>, DisposableBeanDefinition<T>, Element, EnumElement, ExecutableMethod<T,R>, ExecutionHandle<T,R>, FieldElement, GenericPlaceholderElement, InitializingBeanDefinition<T>, InjectableElement, InvocationContext<T,R>, MemberElement, MethodBasedRouteMatch<T,R>, MethodElement, MethodExecutionHandle<T,R>, MethodInvocationContext<T,R>, MethodReference<T,R>, PackageElement, ParameterElement, PropertyElement, ProxyBeanDefinition<T>, TypedElement, UnsafeBeanProperty<B,T>, UriRouteMatch<T,R>, ValidatedBeanDefinition<T>, WildcardElement

All Known Implementing Classes:

AbstractBeanDefinition, AbstractBeanDefinitionBuilder, AbstractBeanIntrospection, AbstractBeanProperty, AbstractEnvironmentAnnotationMetadata, AbstractExecutableBeanMethod, AbstractExecutableMethod, AbstractGroovyElement, AbstractInitializableBeanDefinition, AbstractInitializableBeanIntrospection, AbstractJavaElement, AbstractParametrizedBeanDefinition, AbstractProviderDefinition, AnnotationMetadataHierarchy, AnnotationMetadataReference, ApplicationEventPublisherFactory, BeanDefinitionWriter, BeanProviderDefinition, ConstructorInterceptorChain, DefaultAnnotationMetadata, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement, InterceptorChain, InterceptorRegistryBean, JakartaProviderBeanDefinition, JavaClassElement, JavaMethodElement, JavaPackageElement, JavaxProviderBeanDefinition, MethodInterceptorChain, MutableAnnotationMetadata, PrimitiveElement

public interface AnnotationMetadata
extends AnnotationSource

An interface implemented at compile time by Micronaut that allows the inspection of annotation metadata and stereotypes (meta-annotations)

.

This interface exposes fast and efficient means to expose annotation data at runtime without requiring reflective tricks to read the annotation metadata

Users of Micronaut should in general avoid the methods of the AnnotatedElement interface and use this interface instead to obtain maximum efficiency

Core framework types such as io.micronaut.inject.BeanDefinition and io.micronaut.inject.ExecutableMethod implement this interface

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME_SUFFIX The suffix used when saving compiled metadata to classes.
static AnnotationMetadata	EMPTY_METADATA A constant for representing empty metadata.
static String	VALUE_MEMBER The default value() member.

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Method Summary

Modifier and Type	Method and Description
default Optional<Boolean>	booleanValue(Class<? extends Annotation> annotation) The value as an optional boolean for the given annotation and member.
default Optional<Boolean>	booleanValue(Class<? extends Annotation> annotation, String member) The value as an optional boolean for the given annotation and member.
default Optional<Boolean>	booleanValue(String annotation) The value as an optional boolean for the given annotation and member.
default Optional<Boolean>	booleanValue(String annotation, String member) The value as an optional boolean for the given annotation and member.
default Optional<Class>	classValue(Class<? extends Annotation> annotation) The value of the annotation as a Class.
default Optional<Class>	classValue(Class<? extends Annotation> annotation, String member) The value of the annotation as a Class.
default Optional<Class>	classValue(String annotation) The value of the annotation as a Class.
default Optional<Class>	classValue(String annotation, String member) The value of the annotation as a Class.
default <T> Class<T>[]	classValues(Class<? extends Annotation> annotation) The value of the annotation as a Class.
default <T> Class<T>[]	classValues(Class<? extends Annotation> annotation, String member) The value of the annotation as a Class.
default <T> Class<T>[]	classValues(String annotation) The value of the annotation as a Class.
default <T> Class<T>[]	classValues(String annotation, String member) The value of the annotation as a Class.
default OptionalDouble	doubleValue(Class<? extends Annotation> annotation) The value as an OptionalDouble for the given annotation and member.
default OptionalDouble	doubleValue(Class<? extends Annotation> annotation, String member) The value as an OptionalDouble for the given annotation and member.
default OptionalDouble	doubleValue(String annotation, String member) The value as an OptionalDouble for the given annotation and member.
default <E extends Enum> Optional<E>	enumValue(Class<? extends Annotation> annotation, Class<E> enumType) The value of the annotation as a Class.
default <E extends Enum> Optional<E>	enumValue(Class<? extends Annotation> annotation, String member, Class<E> enumType) The value of the annotation as a Class.
default <E extends Enum> Optional<E>	enumValue(String annotation, Class<E> enumType) The value of the given enum.
default <E extends Enum> Optional<E>	enumValue(String annotation, String member, Class<E> enumType) The value of the annotation as a Class.
default <E extends Enum> E[]	enumValues(Class<? extends Annotation> annotation, Class<E> enumType) The enum values for the given annotation.
default <E extends Enum> E[]	enumValues(Class<? extends Annotation> annotation, String member, Class<E> enumType) The enum values for the given annotation.
default <E extends Enum> E[]	enumValues(String annotation, Class<E> enumType) The enum values for the given annotation.
default <E extends Enum> E[]	enumValues(String annotation, String member, Class<E> enumType) The enum values for the given annotation.
default <T extends Annotation> Optional<AnnotationValue<T>>	findAnnotation(Class<T> annotationClass) Get all of the values for the given annotation.
default <T extends Annotation> Optional<AnnotationValue<T>>	findDeclaredAnnotation(Class<T> annotationClass) Get all of the values for the given annotation that are directly declared on the annotated element.
default Optional<String>	findRepeatableAnnotation(Class<? extends Annotation> annotation) Find repeatable annotation container.
default Optional<String>	findRepeatableAnnotation(String annotation) Find repeatable annotation container.
default Optional<String>	getAnnotationNameByStereotype(Class<? extends Annotation> stereotype) Find the first annotation name for the given stereotype.
default Optional<String>	getAnnotationNameByStereotype(String stereotype) Find the first annotation name for the given stereotype.
default Set<String>	getAnnotationNames() All the annotation names this metadata declares.
default List<String>	getAnnotationNamesByStereotype(Class<? extends Annotation> stereotype) Resolve all of the annotation names that feature the given stereotype.
default List<String>	getAnnotationNamesByStereotype(String stereotype) Resolve all of the annotation names that feature the given stereotype.
default Optional<Class<? extends Annotation>>	getAnnotationType(String name) Gets the type for a given annotation if it is present on the classpath.
default Optional<Class<? extends Annotation>>	getAnnotationType(String name, ClassLoader classLoader) Gets the type for a given annotation if it is present on the classpath.
default Optional<Class<? extends Annotation>>	getAnnotationTypeByStereotype(Class<? extends Annotation> stereotype) Find the first annotation name for the given stereotype.
default Optional<Class<? extends Annotation>>	getAnnotationTypeByStereotype(String stereotype) Find the first annotation name for the given stereotype.
default List<Class<? extends Annotation>>	getAnnotationTypesByStereotype(Class<? extends Annotation> stereotype) Resolve all of the annotation names that feature the given stereotype.
default List<Class<? extends Annotation>>	getAnnotationTypesByStereotype(Class<? extends Annotation> stereotype, ClassLoader classLoader) Resolve all of the annotation names that feature the given stereotype.
default List<Class<? extends Annotation>>	getAnnotationTypesByStereotype(String stereotype) Resolve all of the annotation names that feature the given stereotype.
default <T extends Annotation> List<AnnotationValue<T>>	getAnnotationValuesByName(String annotationType) Gets all the annotation values by the given repeatable type name.
default <T extends Annotation> List<AnnotationValue<T>>	getAnnotationValuesByType(Class<T> annotationType) Gets all the annotation values by the given repeatable type.
default Optional<String>	getDeclaredAnnotationNameByStereotype(String stereotype) Find the first annotation name for the given stereotype.
default Set<String>	getDeclaredAnnotationNames() All the declared annotation names this metadata declares.
default List<String>	getDeclaredAnnotationNamesByStereotype(String stereotype) Resolve all of the annotations names for the given stereotype that are declared annotations.
default Optional<Class<? extends Annotation>>	getDeclaredAnnotationTypeByStereotype(Class<? extends Annotation> stereotype) Find the first declared annotation name for the given stereotype.
default Optional<Class<? extends Annotation>>	getDeclaredAnnotationTypeByStereotype(String stereotype) Find the first annotation name for the given stereotype.
default <T extends Annotation> List<AnnotationValue<T>>	getDeclaredAnnotationValuesByName(String annotationType) Gets only declared annotation values by the given repeatable type name.
default <T extends Annotation> List<AnnotationValue<T>>	getDeclaredAnnotationValuesByType(Class<T> annotationType) Gets only declared annotation values by the given repeatable type.
default AnnotationMetadata	getDeclaredMetadata() Gets the declared metadata without inherited metdata.
default <T> Optional<T>	getDefaultValue(Class<? extends Annotation> annotation, String member, Argument<T> requiredType) Return the default value for the given annotation member.
default <T> Optional<T>	getDefaultValue(Class<? extends Annotation> annotation, String member, Class<T> requiredType) Return the default value for the given annotation member.
default <T> Optional<T>	getDefaultValue(String annotation, String member, Argument<T> requiredType) Return the default value for the given annotation member.
default <T> Optional<T>	getDefaultValue(String annotation, String member, Class<T> requiredType) Return the default value for the given annotation member.
default Map<String,Object>	getDefaultValues(String annotation) Return the default values for the given annotation name.
default Optional<Object>	getValue(Class<? extends Annotation> annotation) Get the value of default "value" the given annotation.
default <T> Optional<T>	getValue(Class<? extends Annotation> annotation, Argument<T> requiredType) Get the value of default "value" the given annotation.
default <T> Optional<T>	getValue(Class<? extends Annotation> annotation, Class<T> requiredType) Get the value of default "value" the given annotation.
default Optional<Object>	getValue(Class<? extends Annotation> annotation, String member) Get the value of the given annotation member.
default <T> Optional<T>	getValue(Class<? extends Annotation> annotation, String member, Argument<T> requiredType) Get the value of the given annotation member.
default <T> Optional<T>	getValue(Class<? extends Annotation> annotation, String member, Class<T> requiredType) Get the value of the given annotation member.
default Optional<Object>	getValue(String annotation) Get the value of default "value" the given annotation.
default <T> Optional<T>	getValue(String annotation, Argument<T> requiredType) Get the value of default "value" the given annotation.
default <T> Optional<T>	getValue(String annotation, Class<T> requiredType) Get the value of default "value" the given annotation.
default Optional<Object>	getValue(String annotation, String member) Get the value of the given annotation member.
default <T> Optional<T>	getValue(String annotation, String member, Argument<T> requiredType) Get the value of the given annotation member.
default <T> Optional<T>	getValue(String annotation, String member, Class<T> requiredType) Get the value of the given annotation member.
default <T> OptionalValues<T>	getValues(Class<? extends Annotation> annotation, Class<T> valueType) Get all of the values for the given annotation.
default Map<CharSequence,Object>	getValues(String annotation) Get all of the values for the given annotation and type of the underlying values.
default <T> OptionalValues<T>	getValues(String annotation, Class<T> valueType) Get all of the values for the given annotation and type of the underlying values.
default boolean	hasAnnotation(Class<? extends Annotation> annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.
default boolean	hasAnnotation(String annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.
default boolean	hasDeclaredAnnotation(Class<? extends Annotation> annotation) Checks whether this object has the given annotation directly declared on the object.
default boolean	hasDeclaredAnnotation(String annotation) Checks whether this object has the given annotation directly declared on the object.
default boolean	hasDeclaredStereotype(Class<? extends Annotation>... annotations) Checks whether this object has any of the given stereotype directly declared on the object.
default boolean	hasDeclaredStereotype(Class<? extends Annotation> stereotype) Checks whether this object has the given stereotype directly declared on the object.
default boolean	hasDeclaredStereotype(String... annotations) Checks whether this object has any of the given stereotype directly declared on the object.
default boolean	hasDeclaredStereotype(String annotation) Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
default boolean	hasPropertyExpressions() Does the metadata contain any property expressions like ${foo.bar}.
default boolean	hasSimpleAnnotation(String annotation) Checks whether the given annotation simple name (name without the package) is present in the annotations.
default boolean	hasSimpleDeclaredAnnotation(String annotation) Checks whether the given annotation simple name (name without the package) is present in the declared annotations.
default boolean	hasStereotype(Class<? extends Annotation>... annotations) Check whether any of the given stereotypes is present.
default boolean	hasStereotype(Class<? extends Annotation> annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
default boolean	hasStereotype(String annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
default boolean	hasStereotype(String[] annotations) Check whether any of the given stereotypes is present.
default OptionalInt	intValue(Class<? extends Annotation> annotation) The value as an OptionalInt for the given annotation and member.
default OptionalInt	intValue(Class<? extends Annotation> annotation, String member) The value as an OptionalInt for the given annotation and member.
default OptionalInt	intValue(String annotation, String member) The value as an OptionalInt for the given annotation and member.
default boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass) Return whether an annotation is present.
default boolean	isAnnotationPresent(String annotationName) Return whether an annotation is present.
default boolean	isDeclaredAnnotationPresent(Class<? extends Annotation> annotationClass) Variation of AnnotationSource.isAnnotationPresent(Class) for declared annotations.
default boolean	isDeclaredAnnotationPresent(String annotationName) Variation of AnnotationSource.isAnnotationPresent(String) for declared annotations.
default boolean	isEmpty() Is the annotation metadata empty.
default boolean	isFalse(Class<? extends Annotation> annotation, String member) Returns whether the value of the given member is true.
default boolean	isFalse(String annotation, String member) Returns whether the value of the given member is true.
default boolean	isPresent(Class<? extends Annotation> annotation, String member) Returns whether the value of the given member is present.
default boolean	isPresent(String annotation, String member) Returns whether the value of the given member is present.
default boolean	isRepeatableAnnotation(Class<? extends Annotation> annotation) Is repeatable annotation?
default boolean	isRepeatableAnnotation(String annotation) Is repeatable annotation?
default boolean	isTrue(Class<? extends Annotation> annotation, String member) Returns whether the value of the given member is true.
default boolean	isTrue(String annotation, String member) Returns whether the value of the given member is true.
default OptionalLong	longValue(Class<? extends Annotation> annotation, String member) The value as an OptionalLong for the given annotation and member.
default OptionalLong	longValue(String annotation, String member) The value as an OptionalLong for the given annotation and member.
default Optional<String>	stringValue(Class<? extends Annotation> annotation) The value as an optional string for the given annotation and member.
default Optional<String>	stringValue(Class<? extends Annotation> annotation, String member) The value as an optional string for the given annotation and member.
default Optional<String>	stringValue(String annotation) The value as an optional string for the given annotation and member.
default Optional<String>	stringValue(String annotation, String member) The value as an optional string for the given annotation and member.
default String[]	stringValues(Class<? extends Annotation> annotation) The values as string array for the given annotation and member.
default String[]	stringValues(Class<? extends Annotation> annotation, String member) The values as string array for the given annotation and member.
default String[]	stringValues(String annotation) The values as string array for the given annotation and member.
default String[]	stringValues(String annotation, String member) The values as string array for the given annotation and member.

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

findAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Field Detail

EMPTY_METADATA

static final AnnotationMetadata EMPTY_METADATA

A constant for representing empty metadata.

VALUE_MEMBER

static final String VALUE_MEMBER

The default value() member.

See Also:

Constant Field Values

CLASS_NAME_SUFFIX

static final String CLASS_NAME_SUFFIX

The suffix used when saving compiled metadata to classes.

See Also:

Constant Field Values

Method Detail

getDeclaredMetadata

@NonNull
default AnnotationMetadata getDeclaredMetadata()

Gets the declared metadata without inherited metdata.

Returns:

The declared metadata

Since:

3.0.0

hasPropertyExpressions

default boolean hasPropertyExpressions()

Does the metadata contain any property expressions like ${foo.bar}. Note this by default returns true as previous versions of Micronaut must assume metadata is present. The compilation time this is computed in order to decide whether to instrument annotation metadata with environment specific logic.

Returns:

True if property expressions are present

getAnnotationNamesByStereotype

@NonNull
default List<String> getAnnotationNamesByStereotype(@Nullable
                                                             String stereotype)

Resolve all of the annotation names that feature the given stereotype.

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getAnnotationNames

@NonNull
default Set<String> getAnnotationNames()

All the annotation names this metadata declares.

Returns:

All the annotation names this metadata declares

getDeclaredAnnotationNames

@NonNull
default Set<String> getDeclaredAnnotationNames()

All the declared annotation names this metadata declares.

Returns:

All the declared annotation names this metadata declares

getDeclaredAnnotationNamesByStereotype

@NonNull
default List<String> getDeclaredAnnotationNamesByStereotype(@Nullable
                                                                     String stereotype)

Resolve all of the annotations names for the given stereotype that are declared annotations.

Parameters:

stereotype - The stereotype

Returns:

The declared annotations

getValues

@NonNull
default <T> OptionalValues<T> getValues(@NonNull
                                                 String annotation,
                                                 @NonNull
                                                 Class<T> valueType)

Get all of the values for the given annotation and type of the underlying values.

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation name

valueType - valueType

Returns:

The OptionalValues

getValues

@NonNull
default Map<CharSequence,Object> getValues(@NonNull
                                                    String annotation)

Get all of the values for the given annotation and type of the underlying values.

Parameters:

annotation - The annotation name

Returns:

An immutable map of values

getDefaultValue

default <T> Optional<T> getDefaultValue(@NonNull
                                        String annotation,
                                        @NonNull
                                        String member,
                                        @NonNull
                                        Argument<T> requiredType)

Return the default value for the given annotation member.

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

getAnnotationValuesByType

@NonNull
default <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByType(@NonNull
                                                                                           Class<T> annotationType)

Gets all the annotation values by the given repeatable type.

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getAnnotationValuesByName

@NonNull
default <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByName(@NonNull
                                                                                           String annotationType)

Gets all the annotation values by the given repeatable type name.

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

Since:

3.2.4

getDeclaredAnnotationValuesByType

@NonNull
default <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull
                                                                                                   Class<T> annotationType)

Gets only declared annotation values by the given repeatable type.

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getDeclaredAnnotationValuesByName

@NonNull
default <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByName(@NonNull
                                                                                                   String annotationType)

Gets only declared annotation values by the given repeatable type name.

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

Since:

3.2.4

hasDeclaredAnnotation

default boolean hasDeclaredAnnotation(@Nullable
                                      String annotation)

Checks whether this object has the given annotation directly declared on the object.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasAnnotation

default boolean hasAnnotation(@Nullable
                              String annotation)

Checks whether this object has the given annotation on the object itself or inherited from a parent.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasSimpleAnnotation

default boolean hasSimpleAnnotation(@Nullable
                                    String annotation)

Checks whether the given annotation simple name (name without the package) is present in the annotations.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasSimpleDeclaredAnnotation

default boolean hasSimpleDeclaredAnnotation(@Nullable
                                            String annotation)

Checks whether the given annotation simple name (name without the package) is present in the declared annotations.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasStereotype

default boolean hasStereotype(@Nullable
                              String annotation)

Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent

.

An annotation stereotype is a meta annotation potentially applied to another annotation

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype

default boolean hasDeclaredStereotype(@Nullable
                                      String annotation)

Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent

.

An annotation stereotype is a meta annotation potentially applied to another annotation

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype

default boolean hasDeclaredStereotype(@Nullable
                                      String... annotations)

Checks whether this object has any of the given stereotype directly declared on the object.

Parameters:

annotations - The annotations

Returns:

True if any of the given stereotypes are present

Since:

2.3.3

getDefaultValues

@NonNull
default Map<String,Object> getDefaultValues(@NonNull
                                                     String annotation)

Return the default values for the given annotation name.

Parameters:

annotation - The annotation name

Returns:

The default values

getDefaultValue

default <T> Optional<T> getDefaultValue(@NonNull
                                        String annotation,
                                        @NonNull
                                        String member,
                                        @NonNull
                                        Class<T> requiredType)

Return the default value for the given annotation member.

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

getDefaultValue

default <T> Optional<T> getDefaultValue(@NonNull
                                        Class<? extends Annotation> annotation,
                                        @NonNull
                                        String member,
                                        @NonNull
                                        Argument<T> requiredType)

Return the default value for the given annotation member.

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

isAnnotationPresent

default boolean isAnnotationPresent(@NonNull
                                    Class<? extends Annotation> annotationClass)

Description copied from interface: AnnotationSource

Return whether an annotation is present.

Specified by:

isAnnotationPresent in interface AnnotationSource

Parameters:

annotationClass - The annotation class

Returns:

True if it is

See Also:

AnnotationSource.isAnnotationPresent(Class)

isDeclaredAnnotationPresent

default boolean isDeclaredAnnotationPresent(@NonNull
                                            Class<? extends Annotation> annotationClass)

Description copied from interface: AnnotationSource

Variation of AnnotationSource.isAnnotationPresent(Class) for declared annotations.

Specified by:

isDeclaredAnnotationPresent in interface AnnotationSource

Parameters:

annotationClass - The annotation class

Returns:

True if it is

See Also:

AnnotationSource.isAnnotationPresent(Class)

isAnnotationPresent

default boolean isAnnotationPresent(@NonNull
                                    String annotationName)

Description copied from interface: AnnotationSource

Return whether an annotation is present.

Specified by:

isAnnotationPresent in interface AnnotationSource

Parameters:

annotationName - The annotation name

Returns:

True if it is

See Also:

AnnotationSource.isAnnotationPresent(String)

isDeclaredAnnotationPresent

default boolean isDeclaredAnnotationPresent(@NonNull
                                            String annotationName)

Description copied from interface: AnnotationSource

Variation of AnnotationSource.isAnnotationPresent(String) for declared annotations.

Specified by:

isDeclaredAnnotationPresent in interface AnnotationSource

Parameters:

annotationName - The annotation name

Returns:

True if it is

See Also:

AnnotationSource.isAnnotationPresent(String)

getDefaultValue

default <T> Optional<T> getDefaultValue(@NonNull
                                        Class<? extends Annotation> annotation,
                                        @NonNull
                                        String member,
                                        @NonNull
                                        Class<T> requiredType)

Return the default value for the given annotation member.

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

getValue

default <T> Optional<T> getValue(@NonNull
                                 Class<? extends Annotation> annotation,
                                 @NonNull
                                 String member,
                                 @NonNull
                                 Class<T> requiredType)

Get the value of the given annotation member.

Type Parameters:

T - The value

Parameters:

annotation - The annotation class

member - The annotation member

requiredType - The required type

Returns:

An Optional of the value

getValue

default <T> Optional<T> getValue(@NonNull
                                 Class<? extends Annotation> annotation,
                                 @NonNull
                                 String member,
                                 @NonNull
                                 Argument<T> requiredType)

Get the value of the given annotation member.

Type Parameters:

T - The value

Parameters:

annotation - The annotation class

member - The annotation member

requiredType - The required type

Returns:

An Optional of the value

getAnnotationNameByStereotype

default Optional<String> getAnnotationNameByStereotype(@Nullable
                                                       String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationNameByStereotype

default Optional<String> getDeclaredAnnotationNameByStereotype(@Nullable
                                                               String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationTypeByStereotype

default Optional<Class<? extends Annotation>> getAnnotationTypeByStereotype(@NonNull
                                                                            Class<? extends Annotation> stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationTypeByStereotype

default Optional<Class<? extends Annotation>> getDeclaredAnnotationTypeByStereotype(@NonNull
                                                                                    Class<? extends Annotation> stereotype)

Find the first declared annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationTypeByStereotype

default Optional<Class<? extends Annotation>> getDeclaredAnnotationTypeByStereotype(@Nullable
                                                                                    String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationType

default Optional<Class<? extends Annotation>> getAnnotationType(@NonNull
                                                                String name,
                                                                @NonNull
                                                                ClassLoader classLoader)

Gets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.

Parameters:

name - The type name

classLoader - The ClassLoader to load the type

Returns:

The type if present

getAnnotationType

default Optional<Class<? extends Annotation>> getAnnotationType(@NonNull
                                                                String name)

Gets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.

Parameters:

name - The type name

Returns:

The type if present

getAnnotationTypeByStereotype

default Optional<Class<? extends Annotation>> getAnnotationTypeByStereotype(@Nullable
                                                                            String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationNameByStereotype

default Optional<String> getAnnotationNameByStereotype(@NonNull
                                                       Class<? extends Annotation> stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getValues

@NonNull
default <T> OptionalValues<T> getValues(@NonNull
                                                 Class<? extends Annotation> annotation,
                                                 @NonNull
                                                 Class<T> valueType)

Get all of the values for the given annotation.

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation name

valueType - valueType

Returns:

The OptionalValues

getAnnotationNamesByStereotype

@NonNull
default List<String> getAnnotationNamesByStereotype(@NonNull
                                                             Class<? extends Annotation> stereotype)

Resolve all of the annotation names that feature the given stereotype.

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getAnnotationTypesByStereotype

@NonNull
default List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull
                                                                                  Class<? extends Annotation> stereotype)

Resolve all of the annotation names that feature the given stereotype.

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getAnnotationTypesByStereotype

@NonNull
default List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull
                                                                                  String stereotype)

Resolve all of the annotation names that feature the given stereotype.

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getAnnotationTypesByStereotype

@NonNull
default List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull
                                                                                  Class<? extends Annotation> stereotype,
                                                                                  @NonNull
                                                                                  ClassLoader classLoader)

Resolve all of the annotation names that feature the given stereotype.

Parameters:

stereotype - The annotation names

classLoader - The classloader to load annotation type

Returns:

A set of annotation names

findAnnotation

default <T extends Annotation> Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                           Class<T> annotationClass)

Get all of the values for the given annotation.

Specified by:

findAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

The AnnotationValue

findDeclaredAnnotation

default <T extends Annotation> Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                   Class<T> annotationClass)

Get all of the values for the given annotation that are directly declared on the annotated element.

Specified by:

findDeclaredAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

A AnnotationValue instance

getValue

default <T> Optional<T> getValue(@NonNull
                                 String annotation,
                                 @NonNull
                                 String member,
                                 @NonNull
                                 Class<T> requiredType)

Get the value of the given annotation member.

Type Parameters:

T - The value

Parameters:

annotation - The annotation class

member - The annotation member

requiredType - The required type

Returns:

An Optional of the value

getValue

default <T> Optional<T> getValue(@NonNull
                                 String annotation,
                                 @NonNull
                                 String member,
                                 @NonNull
                                 Argument<T> requiredType)

Get the value of the given annotation member.

Type Parameters:

T - The value

Parameters:

annotation - The annotation class

member - The annotation member

requiredType - The required type

Returns:

An Optional of the value

longValue

default OptionalLong longValue(@NonNull
                               String annotation,
                               @NonNull
                               String member)

The value as an OptionalLong for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalLong value

longValue

default OptionalLong longValue(@NonNull
                               Class<? extends Annotation> annotation,
                               @NonNull
                               String member)

The value as an OptionalLong for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalLong value

enumValue

default <E extends Enum> Optional<E> enumValue(@NonNull
                                               String annotation,
                                               Class<E> enumType)

The value of the given enum.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An Optional enum value

enumValue

default <E extends Enum> Optional<E> enumValue(@NonNull
                                               String annotation,
                                               @NonNull
                                               String member,
                                               Class<E> enumType)

The value of the annotation as a Class.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The annotation member

enumType - The enum type

Returns:

An Optional class

enumValue

default <E extends Enum> Optional<E> enumValue(@NonNull
                                               Class<? extends Annotation> annotation,
                                               Class<E> enumType)

The value of the annotation as a Class.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An Optional class

enumValue

default <E extends Enum> Optional<E> enumValue(@NonNull
                                               Class<? extends Annotation> annotation,
                                               @NonNull
                                               String member,
                                               Class<E> enumType)

The value of the annotation as a Class.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The annotation member

enumType - The enum type

Returns:

An Optional class

enumValues

default <E extends Enum> E[] enumValues(@NonNull
                                        String annotation,
                                        Class<E> enumType)

The enum values for the given annotation.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An array of enum values

enumValues

default <E extends Enum> E[] enumValues(@NonNull
                                        String annotation,
                                        @NonNull
                                        String member,
                                        Class<E> enumType)

The enum values for the given annotation.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The annotation member

enumType - The enum type

Returns:

An array of enum values

enumValues

default <E extends Enum> E[] enumValues(@NonNull
                                        Class<? extends Annotation> annotation,
                                        Class<E> enumType)

The enum values for the given annotation.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An array of enum values

enumValues

default <E extends Enum> E[] enumValues(@NonNull
                                        Class<? extends Annotation> annotation,
                                        @NonNull
                                        String member,
                                        Class<E> enumType)

The enum values for the given annotation.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The annotation member

enumType - The enum type

Returns:

An array of enum values

classValues

@NonNull
default <T> Class<T>[] classValues(@NonNull
                                            String annotation)

The value of the annotation as a Class.

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

Returns:

An Optional class

classValues

@NonNull
default <T> Class<T>[] classValues(@NonNull
                                            String annotation,
                                            @NonNull
                                            String member)

The value of the annotation as a Class.

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValues

@NonNull
default <T> Class<T>[] classValues(@NonNull
                                            Class<? extends Annotation> annotation)

The value of the annotation as a Class.

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

Returns:

An Optional class

classValues

@NonNull
default <T> Class<T>[] classValues(@NonNull
                                            Class<? extends Annotation> annotation,
                                            @NonNull
                                            String member)

The value of the annotation as a Class.

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValue

default Optional<Class> classValue(@NonNull
                                   String annotation)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

Returns:

An Optional class

classValue

default Optional<Class> classValue(@NonNull
                                   String annotation,
                                   @NonNull
                                   String member)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValue

default Optional<Class> classValue(@NonNull
                                   Class<? extends Annotation> annotation)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

Returns:

An Optional class

classValue

default Optional<Class> classValue(@NonNull
                                   Class<? extends Annotation> annotation,
                                   @NonNull
                                   String member)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

intValue

default OptionalInt intValue(@NonNull
                             String annotation,
                             @NonNull
                             String member)

The value as an OptionalInt for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalInt value

intValue

default OptionalInt intValue(@NonNull
                             Class<? extends Annotation> annotation,
                             @NonNull
                             String member)

The value as an OptionalInt for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalInt value

intValue

default OptionalInt intValue(@NonNull
                             Class<? extends Annotation> annotation)

The value as an OptionalInt for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

THe OptionalInt value

stringValue

default Optional<String> stringValue(@NonNull
                                     String annotation,
                                     @NonNull
                                     String member)

The value as an optional string for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

stringValue

default Optional<String> stringValue(@NonNull
                                     Class<? extends Annotation> annotation,
                                     @NonNull
                                     String member)

The value as an optional string for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

stringValue

@NonNull
default Optional<String> stringValue(@NonNull
                                              Class<? extends Annotation> annotation)

The value as an optional string for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string value if it is present

stringValue

@NonNull
default Optional<String> stringValue(@NonNull
                                              String annotation)

The value as an optional string for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string value if it is present

booleanValue

default Optional<Boolean> booleanValue(@NonNull
                                       String annotation,
                                       @NonNull
                                       String member)

The value as an optional boolean for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

booleanValue

default Optional<Boolean> booleanValue(@NonNull
                                       Class<? extends Annotation> annotation,
                                       @NonNull
                                       String member)

The value as an optional boolean for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

booleanValue

@NonNull
default Optional<Boolean> booleanValue(@NonNull
                                                Class<? extends Annotation> annotation)

The value as an optional boolean for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string value if it is present

booleanValue

@NonNull
default Optional<Boolean> booleanValue(@NonNull
                                                String annotation)

The value as an optional boolean for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string value if it is present

stringValues

@NonNull
default String[] stringValues(@NonNull
                                       Class<? extends Annotation> annotation,
                                       @NonNull
                                       String member)

The values as string array for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string values if it is present

stringValues

@NonNull
default String[] stringValues(@NonNull
                                       Class<? extends Annotation> annotation)

The values as string array for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string values if it is present

stringValues

@NonNull
default String[] stringValues(@NonNull
                                       String annotation,
                                       @NonNull
                                       String member)

The values as string array for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

The string values if it is present

stringValues

@NonNull
default String[] stringValues(@NonNull
                                       String annotation)

The values as string array for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

The string values if it is present

doubleValue

@NonNull
default OptionalDouble doubleValue(@NonNull
                                            String annotation,
                                            @NonNull
                                            String member)

The value as an OptionalDouble for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalDouble value

doubleValue

@NonNull
default OptionalDouble doubleValue(@NonNull
                                            Class<? extends Annotation> annotation,
                                            @NonNull
                                            String member)

The value as an OptionalDouble for the given annotation and member.

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalDouble value

doubleValue

@NonNull
default OptionalDouble doubleValue(@NonNull
                                            Class<? extends Annotation> annotation)

The value as an OptionalDouble for the given annotation and member.

Parameters:

annotation - The annotation

Returns:

THe OptionalDouble value

getValue

@NonNull
default <T> Optional<T> getValue(@NonNull
                                          String annotation,
                                          @NonNull
                                          Class<T> requiredType)

Get the value of default "value" the given annotation.

Type Parameters:

T - The value

Parameters:

annotation - The annotation class

requiredType - The required type

Returns:

An Optional of the value

getValue

@NonNull
default Optional<Object> getValue(@NonNull
                                           String annotation,
                                           @NonNull
                                           String member)

Get the value of the given annotation member.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

An Optional of the value

getValue

@NonNull
default Optional<Object> getValue(@NonNull
                                           Class<? extends Annotation> annotation,
                                           @NonNull
                                           String member)

Get the value of the given annotation member.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

An Optional of the value

isTrue

default boolean isTrue(@NonNull
                       String annotation,
                       @NonNull
                       String member)

Returns whether the value of the given member is true.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isTrue

default boolean isTrue(@NonNull
                       Class<? extends Annotation> annotation,
                       @NonNull
                       String member)

Returns whether the value of the given member is true.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isPresent

default boolean isPresent(@NonNull
                          String annotation,
                          @NonNull
                          String member)

Returns whether the value of the given member is present.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isPresent

default boolean isPresent(@NonNull
                          Class<? extends Annotation> annotation,
                          @NonNull
                          String member)

Returns whether the value of the given member is present.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isFalse

default boolean isFalse(@NonNull
                        Class<? extends Annotation> annotation,
                        @NonNull
                        String member)

Returns whether the value of the given member is true.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isFalse

default boolean isFalse(@NonNull
                        String annotation,
                        @NonNull
                        String member)

Returns whether the value of the given member is true.

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

getValue

@NonNull
default Optional<Object> getValue(@NonNull
                                           String annotation)

Get the value of default "value" the given annotation.

Parameters:

annotation - The annotation class

Returns:

An Optional of the value

getValue

@NonNull
default Optional<Object> getValue(@NonNull
                                           Class<? extends Annotation> annotation)

Get the value of default "value" the given annotation.

Parameters:

annotation - The annotation class

Returns:

An Optional of the value

getValue

@NonNull
default <T> Optional<T> getValue(@NonNull
                                          Class<? extends Annotation> annotation,
                                          @NonNull
                                          Class<T> requiredType)

Get the value of default "value" the given annotation.

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation class

requiredType - requiredType

Returns:

An Optional of the value

getValue

@NonNull
default <T> Optional<T> getValue(@NonNull
                                          Class<? extends Annotation> annotation,
                                          @NonNull
                                          Argument<T> requiredType)

Get the value of default "value" the given annotation.

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation class

requiredType - requiredType

Returns:

An Optional of the value

getValue

@NonNull
default <T> Optional<T> getValue(@NonNull
                                          String annotation,
                                          @NonNull
                                          Argument<T> requiredType)

Get the value of default "value" the given annotation.

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation class

requiredType - requiredType

Returns:

An Optional of the value

hasAnnotation

default boolean hasAnnotation(@Nullable
                              Class<? extends Annotation> annotation)

Checks whether this object has the given annotation on the object itself or inherited from a parent.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasStereotype

default boolean hasStereotype(@Nullable
                              Class<? extends Annotation> annotation)

Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent

.

An annotation stereotype is a meta annotation potentially applied to another annotation

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasStereotype

default boolean hasStereotype(@Nullable
                              Class<? extends Annotation>... annotations)

Check whether any of the given stereotypes is present.

Parameters:

annotations - The annotations

Returns:

True if any of the given stereotypes are present

hasStereotype

default boolean hasStereotype(@Nullable
                              String[] annotations)

Check whether any of the given stereotypes is present.

Parameters:

annotations - The annotations

Returns:

True if any of the given stereotypes are present

hasDeclaredAnnotation

default boolean hasDeclaredAnnotation(@Nullable
                                      Class<? extends Annotation> annotation)

Checks whether this object has the given annotation directly declared on the object.

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype

default boolean hasDeclaredStereotype(@Nullable
                                      Class<? extends Annotation> stereotype)

Checks whether this object has the given stereotype directly declared on the object.

Parameters:

stereotype - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype

default boolean hasDeclaredStereotype(@Nullable
                                      Class<? extends Annotation>... annotations)

Checks whether this object has any of the given stereotype directly declared on the object.

Parameters:

annotations - The annotations

Returns:

True if any of the given stereotypes are present

isRepeatableAnnotation

default boolean isRepeatableAnnotation(@NonNull
                                       Class<? extends Annotation> annotation)

Is repeatable annotation?

Parameters:

annotation - The annotation

Returns:

true if repeatable

Since:

3.1

isRepeatableAnnotation

default boolean isRepeatableAnnotation(@NonNull
                                       String annotation)

Is repeatable annotation?

Parameters:

annotation - The annotation

Returns:

true if repeatable

Since:

3.1

findRepeatableAnnotation

default Optional<String> findRepeatableAnnotation(@NonNull
                                                  Class<? extends Annotation> annotation)

Find repeatable annotation container.

Parameters:

annotation - The annotation

Returns:

optional repeatable annotation container

Since:

3.1

findRepeatableAnnotation

default Optional<String> findRepeatableAnnotation(@NonNull
                                                  String annotation)

Find repeatable annotation container.

Parameters:

annotation - The annotation

Returns:

optional repeatable annotation container

Since:

3.1

isEmpty

default boolean isEmpty()

Is the annotation metadata empty.

Returns:

True if it is