io.micronaut.core.annotation

Interface AnnotationMetadata

All Superinterfaces:

AnnotationSource

All Known Subinterfaces:

AnnotationMetadataDelegate, BeanDefinition<T>, BeanDefinitionMethodReference<T,R>, BeanIntrospection<T>, BeanProperty<B,T>, ClassElement, ConstructorElement, DelegatingBeanDefinition<T>, DelegatingExecutableMethod<T,R>, DisposableBeanDefinition<T>, Element, EnumElement, ExecutableMethod<T,R>, ExecutionHandle<T,R>, FieldElement, InitializingBeanDefinition<T>, InvocationContext<T,R>, MemberElement, MethodBasedRouteMatch<T,R>, MethodElement, MethodExecutionHandle<T,R>, MethodInvocationContext<T,R>, MethodReference<T,R>, ParameterElement, PropertyElement, ProxyBeanDefinition<T>, TypedElement, UriRouteMatch<T,R>, ValidatedBeanDefinition<T>

All Known Implementing Classes:

AbstractBeanDefinition, AbstractBeanIntrospection, AbstractBeanProperty, AbstractEnvironmentAnnotationMetadata, AbstractExecutableMethod, AbstractGroovyElement, AbstractJavaElement, AbstractParametrizedBeanDefinition, AnnotationMetadataHierarchy, AnnotationMetadataReference, DefaultAnnotationMetadata, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement, InterceptorChain, JavaClassElement, JavaPackageElement, MethodInterceptorChain, 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 java.lang.String	CLASS_NAME_SUFFIX The suffix used when saving compiled metadata to classes.
static AnnotationMetadata	EMPTY_METADATA A constant for representing empty metadata.
static java.lang.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 java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value as an optional boolean for the given annotation and member.
default java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an optional boolean for the given annotation and member.
default java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.String annotation) The value as an optional boolean for the given annotation and member.
default java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.String annotation, java.lang.String member) The value as an optional boolean for the given annotation and member.
default java.util.Optional<java.lang.Class>	classValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value of the annotation as a Class.
default java.util.Optional<java.lang.Class>	classValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value of the annotation as a Class.
default java.util.Optional<java.lang.Class>	classValue(java.lang.String annotation) The value of the annotation as a Class.
default java.util.Optional<java.lang.Class>	classValue(java.lang.String annotation, java.lang.String member) The value of the annotation as a Class.
default <T> java.lang.Class<T>[]	classValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value of the annotation as a Class.
default <T> java.lang.Class<T>[]	classValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value of the annotation as a Class.
default <T> java.lang.Class<T>[]	classValues(java.lang.String annotation) The value of the annotation as a Class.
default <T> java.lang.Class<T>[]	classValues(java.lang.String annotation, java.lang.String member) The value of the annotation as a Class.
default java.util.OptionalDouble	doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value as an OptionalDouble for the given annotation and member.
default java.util.OptionalDouble	doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an OptionalDouble for the given annotation and member.
default java.util.OptionalDouble	doubleValue(java.lang.String annotation, java.lang.String member) The value as an OptionalDouble for the given annotation and member.
default <E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<E> enumType) The value of the annotation as a Class.
default <E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType) The value of the annotation as a Class.
default <E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.String annotation, java.lang.Class<E> enumType) The value of the given enum.
default <E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType) The value of the annotation as a Class.
default <E extends java.lang.Enum> E[]	enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<E> enumType) The enum values for the given annotation.
default <E extends java.lang.Enum> E[]	enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType) The enum values for the given annotation.
default <E extends java.lang.Enum> E[]	enumValues(java.lang.String annotation, java.lang.Class<E> enumType) The enum values for the given annotation.
default <E extends java.lang.Enum> E[]	enumValues(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType) The enum values for the given annotation.
default <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findAnnotation(java.lang.Class<T> annotationClass) Get all of the values for the given annotation.
default <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findDeclaredAnnotation(java.lang.Class<T> annotationClass) Get all of the values for the given annotation that are directly declared on the annotated element.
default java.util.Optional<java.lang.String>	getAnnotationNameByStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Find the first annotation name for the given stereotype.
default java.util.Optional<java.lang.String>	getAnnotationNameByStereotype(java.lang.String stereotype) Find the first annotation name for the given stereotype.
default java.util.Set<java.lang.String>	getAnnotationNames() All the annotation names this metadata declares.
default java.util.List<java.lang.String>	getAnnotationNamesByStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Resolve all of the annotation names that feature the given stereotype.
default java.util.List<java.lang.String>	getAnnotationNamesByStereotype(java.lang.String stereotype) Resolve all of the annotation names that feature the given stereotype.
default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationType(java.lang.String name) Gets the type for a given annotation if it is present on the classpath.
default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationTypeByStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Find the first annotation name for the given stereotype.
default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationTypeByStereotype(java.lang.String stereotype) Find the first annotation name for the given stereotype.
default java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationTypesByStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Resolve all of the annotation names that feature the given stereotype.
default <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>	getAnnotationValuesByType(java.lang.Class<T> annotationType) Gets all the annotation values by the given repeatable type.
default java.util.Optional<java.lang.String>	getDeclaredAnnotationNameByStereotype(java.lang.String stereotype) Find the first annotation name for the given stereotype.
default java.util.Set<java.lang.String>	getDeclaredAnnotationNames() All the declared annotation names this metadata declares.
default java.util.List<java.lang.String>	getDeclaredAnnotationNamesByStereotype(java.lang.String stereotype) Resolve all of the annotations names for the given stereotype that are declared annotations.
default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getDeclaredAnnotationTypeByStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Find the first declared annotation name for the given stereotype.
default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getDeclaredAnnotationTypeByStereotype(java.lang.String stereotype) Find the first annotation name for the given stereotype.
default <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>	getDeclaredAnnotationValuesByType(java.lang.Class<T> annotationType) Gets only declared annotation values by the given repeatable type.
default <T> java.util.Optional<T>	getDefaultValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, Argument<T> requiredType) Return the default value for the given annotation member.
default <T> java.util.Optional<T>	getDefaultValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<T> requiredType) Return the default value for the given annotation member.
default <T> java.util.Optional<T>	getDefaultValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType) Return the default value for the given annotation member.
default <T> java.util.Optional<T>	getDefaultValue(java.lang.String annotation, java.lang.String member, java.lang.Class<T> requiredType) Return the default value for the given annotation member.
default java.util.Map<java.lang.String,java.lang.Object>	getDefaultValues(java.lang.String annotation) Return the default values for the given annotation name.
default java.util.Optional<java.lang.Object>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Get the value of default "value" the given annotation.
default <T> java.util.Optional<T>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, Argument<T> requiredType) Get the value of default "value" the given annotation.
default <T> java.util.Optional<T>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<T> requiredType) Get the value of default "value" the given annotation.
default java.util.Optional<java.lang.Object>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) Get the value of the given annotation member.
default <T> java.util.Optional<T>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, Argument<T> requiredType) Get the value of the given annotation member.
default <T> java.util.Optional<T>	getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<T> requiredType) Get the value of the given annotation member.
default java.util.Optional<java.lang.Object>	getValue(java.lang.String annotation) Get the value of default "value" the given annotation.
default <T> java.util.Optional<T>	getValue(java.lang.String annotation, Argument<T> requiredType) Get the value of default "value" the given annotation.
default <T> java.util.Optional<T>	getValue(java.lang.String annotation, java.lang.Class<T> requiredType) Get the value of default "value" the given annotation.
default java.util.Optional<java.lang.Object>	getValue(java.lang.String annotation, java.lang.String member) Get the value of the given annotation member.
default <T> java.util.Optional<T>	getValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType) Get the value of the given annotation member.
default <T> java.util.Optional<T>	getValue(java.lang.String annotation, java.lang.String member, java.lang.Class<T> requiredType) Get the value of the given annotation member.
default <T> OptionalValues<T>	getValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<T> valueType) Get all of the values for the given annotation.
default <T> OptionalValues<T>	getValues(java.lang.String annotation, java.lang.Class<T> valueType) Get all of the values for the given annotation and type of the underlying values.
default boolean	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.
default boolean	hasAnnotation(java.lang.String annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.
default boolean	hasDeclaredAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Checks whether this object has the given annotation directly declared on the object.
default boolean	hasDeclaredAnnotation(java.lang.String annotation) Checks whether this object has the given annotation directly declared on the object.
default boolean	hasDeclaredStereotype(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations) Checks whether this object has any of the given stereotype directly declared on the object.
default boolean	hasDeclaredStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Checks whether this object has the given stereotype directly declared on the object.
default boolean	hasDeclaredStereotype(java.lang.String annotation) Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
default boolean	hasSimpleAnnotation(java.lang.String annotation) Checks whether the given annotation simple name (name without the package) is present in the annotations.
default boolean	hasSimpleDeclaredAnnotation(java.lang.String annotation) Checks whether the given annotation simple name (name without the package) is present in the declared annotations.
default boolean	hasStereotype(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations) Check whether any of the given stereotypes is present.
default boolean	hasStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
default boolean	hasStereotype(java.lang.String annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
default boolean	hasStereotype(java.lang.String[] annotations) Check whether any of the given stereotypes is present.
default java.util.OptionalInt	intValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value as an OptionalInt for the given annotation and member.
default java.util.OptionalInt	intValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an OptionalInt for the given annotation and member.
default java.util.OptionalInt	intValue(java.lang.String annotation, java.lang.String member) The value as an OptionalInt for the given annotation and member.
default boolean	isAnnotationPresent(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass) Return whether an annotation is present.
default boolean	isDeclaredAnnotationPresent(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass) Variation of AnnotationSource.isAnnotationPresent(Class) for declared annotations.
default boolean	isEmpty() Is the annotation metadata empty.
default boolean	isFalse(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) Returns whether the value of the given member is true.
default boolean	isFalse(java.lang.String annotation, java.lang.String member) Returns whether the value of the given member is true.
default boolean	isPresent(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) Returns whether the value of the given member is present.
default boolean	isPresent(java.lang.String annotation, java.lang.String member) Returns whether the value of the given member is present.
default boolean	isTrue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) Returns whether the value of the given member is true.
default boolean	isTrue(java.lang.String annotation, java.lang.String member) Returns whether the value of the given member is true.
default java.util.OptionalLong	longValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an OptionalLong for the given annotation and member.
default java.util.OptionalLong	longValue(java.lang.String annotation, java.lang.String member) The value as an OptionalLong for the given annotation and member.
default java.util.Optional<java.lang.String>	stringValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The value as an optional string for the given annotation and member.
default java.util.Optional<java.lang.String>	stringValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an optional string for the given annotation and member.
default java.util.Optional<java.lang.String>	stringValue(java.lang.String annotation) The value as an optional string for the given annotation and member.
default java.util.Optional<java.lang.String>	stringValue(java.lang.String annotation, java.lang.String member) The value as an optional string for the given annotation and member.
default java.lang.String[]	stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) The values as string array for the given annotation and member.
default java.lang.String[]	stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.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, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Field Detail

EMPTY_METADATA

static final AnnotationMetadata EMPTY_METADATA

A constant for representing empty metadata.

VALUE_MEMBER

static final java.lang.String VALUE_MEMBER

The default value() member.

See Also:

Constant Field Values

CLASS_NAME_SUFFIX

static final java.lang.String CLASS_NAME_SUFFIX

The suffix used when saving compiled metadata to classes.

See Also:

Constant Field Values

Method Detail

getAnnotationNamesByStereotype

@NonNull
default java.util.List<java.lang.String> getAnnotationNamesByStereotype(@Nullable
                                                                                 java.lang.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 java.util.Set<java.lang.String> getAnnotationNames()

All the annotation names this metadata declares.

Returns:

All the annotation names this metadata declares

getDeclaredAnnotationNames

@NonNull
default java.util.Set<java.lang.String> getDeclaredAnnotationNames()

All the declared annotation names this metadata declares.

Returns:

All the declared annotation names this metadata declares

getDeclaredAnnotationNamesByStereotype

@NonNull
default java.util.List<java.lang.String> getDeclaredAnnotationNamesByStereotype(@Nullable
                                                                                         java.lang.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
                                                 java.lang.String annotation,
                                                 @NonNull
                                                 java.lang.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

getDefaultValue

default <T> java.util.Optional<T> getDefaultValue(@NonNull
                                                  java.lang.String annotation,
                                                  @NonNull
                                                  java.lang.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 java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getAnnotationValuesByType(@NonNull
                                                                                                                          java.lang.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

getDeclaredAnnotationValuesByType

@NonNull
default <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull
                                                                                                                                  java.lang.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

hasDeclaredAnnotation

default boolean hasDeclaredAnnotation(@Nullable
                                      java.lang.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
                              java.lang.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
                                    java.lang.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
                                            java.lang.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
                              java.lang.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
                                      java.lang.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

getDefaultValues

@NonNull
default java.util.Map<java.lang.String,java.lang.Object> getDefaultValues(@NonNull
                                                                                   java.lang.String annotation)

Return the default values for the given annotation name.

Parameters:

annotation - The annotation name

Returns:

The default values

getDefaultValue

default <T> java.util.Optional<T> getDefaultValue(@NonNull
                                                  java.lang.String annotation,
                                                  @NonNull
                                                  java.lang.String member,
                                                  @NonNull
                                                  java.lang.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> java.util.Optional<T> getDefaultValue(@NonNull
                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                  @NonNull
                                                  java.lang.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
                                    java.lang.Class<? extends java.lang.annotation.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
                                            java.lang.Class<? extends java.lang.annotation.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)

getDefaultValue

default <T> java.util.Optional<T> getDefaultValue(@NonNull
                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                  @NonNull
                                                  java.lang.String member,
                                                  @NonNull
                                                  java.lang.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> java.util.Optional<T> getValue(@NonNull
                                           java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                           @NonNull
                                           java.lang.String member,
                                           @NonNull
                                           java.lang.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> java.util.Optional<T> getValue(@NonNull
                                           java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                           @NonNull
                                           java.lang.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 java.util.Optional<java.lang.String> getAnnotationNameByStereotype(@Nullable
                                                                           java.lang.String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationNameByStereotype

default java.util.Optional<java.lang.String> getDeclaredAnnotationNameByStereotype(@Nullable
                                                                                   java.lang.String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationTypeByStereotype

default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationTypeByStereotype(@NonNull
                                                                                                                     java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationTypeByStereotype

default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getDeclaredAnnotationTypeByStereotype(@NonNull
                                                                                                                             java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)

Find the first declared annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getDeclaredAnnotationTypeByStereotype

default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getDeclaredAnnotationTypeByStereotype(@Nullable
                                                                                                                             java.lang.String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationType

default java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationType(@NonNull
                                                                                                         java.lang.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 java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationTypeByStereotype(@Nullable
                                                                                                                     java.lang.String stereotype)

Find the first annotation name for the given stereotype.

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationNameByStereotype

default java.util.Optional<java.lang.String> getAnnotationNameByStereotype(@NonNull
                                                                           java.lang.Class<? extends java.lang.annotation.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
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 @NonNull
                                                 java.lang.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 java.util.List<java.lang.String> getAnnotationNamesByStereotype(@NonNull
                                                                                 java.lang.Class<? extends java.lang.annotation.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 java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationTypesByStereotype(@NonNull
                                                                                                                           java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)

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

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

findAnnotation

default <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                                          java.lang.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 java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                                                  java.lang.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> java.util.Optional<T> getValue(@NonNull
                                           java.lang.String annotation,
                                           @NonNull
                                           java.lang.String member,
                                           @NonNull
                                           java.lang.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> java.util.Optional<T> getValue(@NonNull
                                           java.lang.String annotation,
                                           @NonNull
                                           java.lang.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 java.util.OptionalLong longValue(@NonNull
                                         java.lang.String annotation,
                                         @NonNull
                                         java.lang.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 java.util.OptionalLong longValue(@NonNull
                                         java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                         @NonNull
                                         java.lang.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 java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                   java.lang.String annotation,
                                                                   java.lang.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 java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                   java.lang.String annotation,
                                                                   @NonNull
                                                                   java.lang.String member,
                                                                   java.lang.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 java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                   java.lang.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 java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                   @NonNull
                                                                   java.lang.String member,
                                                                   java.lang.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 java.lang.Enum> E[] enumValues(@NonNull
                                                  java.lang.String annotation,
                                                  java.lang.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 java.lang.Enum> E[] enumValues(@NonNull
                                                  java.lang.String annotation,
                                                  @NonNull
                                                  java.lang.String member,
                                                  java.lang.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 java.lang.Enum> E[] enumValues(@NonNull
                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                  java.lang.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 java.lang.Enum> E[] enumValues(@NonNull
                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                  @NonNull
                                                  java.lang.String member,
                                                  java.lang.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> java.lang.Class<T>[] classValues(@NonNull
                                                      java.lang.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> java.lang.Class<T>[] classValues(@NonNull
                                                      java.lang.String annotation,
                                                      @NonNull
                                                      java.lang.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> java.lang.Class<T>[] classValues(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.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> java.lang.Class<T>[] classValues(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                      @NonNull
                                                      java.lang.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 java.util.Optional<java.lang.Class> classValue(@NonNull
                                                       java.lang.String annotation)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

Returns:

An Optional class

classValue

default java.util.Optional<java.lang.Class> classValue(@NonNull
                                                       java.lang.String annotation,
                                                       @NonNull
                                                       java.lang.String member)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValue

default java.util.Optional<java.lang.Class> classValue(@NonNull
                                                       java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

The value of the annotation as a Class.

Parameters:

annotation - The annotation

Returns:

An Optional class

classValue

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

The value of the annotation as a Class.

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

intValue

default java.util.OptionalInt intValue(@NonNull
                                       java.lang.String annotation,
                                       @NonNull
                                       java.lang.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 java.util.OptionalInt intValue(@NonNull
                                       java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                       @NonNull
                                       java.lang.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 java.util.OptionalInt intValue(@NonNull
                                       java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

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

Parameters:

annotation - The annotation

Returns:

THe OptionalInt value

stringValue

default java.util.Optional<java.lang.String> stringValue(@NonNull
                                                         java.lang.String annotation,
                                                         @NonNull
                                                         java.lang.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 java.util.Optional<java.lang.String> stringValue(@NonNull
                                                         java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                         @NonNull
                                                         java.lang.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 java.util.Optional<java.lang.String> stringValue(@NonNull
                                                                  java.lang.Class<? extends java.lang.annotation.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 java.util.Optional<java.lang.String> stringValue(@NonNull
                                                                  java.lang.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 java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                           java.lang.String annotation,
                                                           @NonNull
                                                           java.lang.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 java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                           java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                           @NonNull
                                                           java.lang.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 java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                                    java.lang.Class<? extends java.lang.annotation.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 java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                                    java.lang.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 java.lang.String[] stringValues(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 @NonNull
                                                 java.lang.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 java.lang.String[] stringValues(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.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

doubleValue

@NonNull
default java.util.OptionalDouble doubleValue(@NonNull
                                                      java.lang.String annotation,
                                                      @NonNull
                                                      java.lang.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 java.util.OptionalDouble doubleValue(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                      @NonNull
                                                      java.lang.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 java.util.OptionalDouble doubleValue(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.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> java.util.Optional<T> getValue(@NonNull
                                                    java.lang.String annotation,
                                                    @NonNull
                                                    java.lang.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 java.util.Optional<java.lang.Object> getValue(@NonNull
                                                               java.lang.String annotation,
                                                               @NonNull
                                                               java.lang.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 java.util.Optional<java.lang.Object> getValue(@NonNull
                                                               java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                               @NonNull
                                                               java.lang.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
                       java.lang.String annotation,
                       @NonNull
                       java.lang.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
                       java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                       @NonNull
                       java.lang.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
                          java.lang.String annotation,
                          @NonNull
                          java.lang.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
                          java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                          @NonNull
                          java.lang.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
                        java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                        @NonNull
                        java.lang.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
                        java.lang.String annotation,
                        @NonNull
                        java.lang.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 java.util.Optional<java.lang.Object> getValue(@NonNull
                                                               java.lang.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 java.util.Optional<java.lang.Object> getValue(@NonNull
                                                               java.lang.Class<? extends java.lang.annotation.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> java.util.Optional<T> getValue(@NonNull
                                                    java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                    @NonNull
                                                    java.lang.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> java.util.Optional<T> getValue(@NonNull
                                                    java.lang.Class<? extends java.lang.annotation.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> java.util.Optional<T> getValue(@NonNull
                                                    java.lang.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
                              java.lang.Class<? extends java.lang.annotation.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
                              java.lang.Class<? extends java.lang.annotation.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
                              java.lang.Class<? extends java.lang.annotation.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
                              java.lang.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
                                      java.lang.Class<? extends java.lang.annotation.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
                                      java.lang.Class<? extends java.lang.annotation.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
                                      java.lang.Class<? extends java.lang.annotation.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

isEmpty

default boolean isEmpty()

Is the annotation metadata empty.

Returns:

True if it is