io.micronaut.core.annotation

Interface AnnotationSource

All Known Subinterfaces:

AdvisedBeanType<T>, AnnotatedElement, AnnotationElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, Argument<T>, ArgumentConversionContext<T>, ArgumentInjectionPoint<B,T>, ArgumentValue<V>, ArrayableClassElement, BeanConfiguration, BeanConstructor<T>, BeanConstructorElement, BeanDefinition<T>, BeanDefinitionMethodReference<T,R>, BeanDefinitionReference<T>, BeanElement, BeanElementBuilder, BeanFieldElement, BeanIntrospection<T>, BeanIntrospectionReference<T>, BeanMethod<B,T>, BeanMethodElement, BeanParameterElement, BeanProperty<B,T>, BeanType<T>, BeanWrapper<T>, BoundExecutable<T,R>, CallableInjectionPoint<T>, ClassElement, ConfigurableElement, ConstructorElement, ConstructorInjectionPoint<T>, ConstructorInvocationContext<T>, ConversionContext, DelegatingBeanDefinition<T>, DelegatingExecutableMethod<T,R>, DisposableBeanDefinition<T>, Element, EnumElement, Executable<T,R>, ExecutableMethod<T,R>, ExecutionHandle<T,R>, FieldElement, FieldInjectionPoint<B,T>, FilterRoute, GenericPlaceholder<T>, GenericPlaceholderElement, HttpFilterResolver.FilterEntry<F>, ImmutableArgumentConversionContext<T>, InitializingBeanDefinition<T>, InjectableElement, InjectionPoint<T>, InvocationContext<T,R>, MemberElement, MethodBasedRouteMatch<T,R>, MethodElement, MethodExecutionHandle<T,R>, MethodInjectionPoint<B,T>, MethodInvocationContext<T,R>, MethodReference<T,R>, MutableArgumentValue<V>, PackageElement, ParameterElement, PropertyElement, ProxyBeanDefinition<T>, ReturnType<T>, RouteInfo<R>, RouteMatch<R>, TypedElement, TypeInformation<T>, UnsafeBeanProperty<B,T>, UriRouteMatch<T,R>, ValidatedBeanDefinition<T>, WildcardElement

All Known Implementing Classes:

AbstractBeanConfiguration, AbstractBeanConstructor, AbstractBeanDefinition, AbstractBeanDefinitionBuilder, AbstractBeanDefinitionReference, AbstractBeanIntrospection, AbstractBeanIntrospectionReference, AbstractBeanMethod, AbstractBeanProperty, AbstractBeanResolutionContext.AnnotationSegment, AbstractBeanResolutionContext.ConstructorArgumentSegment, AbstractBeanResolutionContext.FieldSegment, AbstractBeanResolutionContext.MethodArgumentSegment, AbstractBeanResolutionContext.MethodSegment, AbstractConstructorInjectionPoint, AbstractEnvironmentAnnotationMetadata, AbstractExecutableBeanMethod, AbstractExecutableMethod, AbstractGroovyElement, AbstractInitializableBeanDefinition, AbstractInitializableBeanDefinitionReference, AbstractInitializableBeanIntrospection, AbstractJavaElement, AbstractParametrizedBeanDefinition, AbstractProviderDefinition, AnnotationMetadataHierarchy, AnnotationMetadataReference, ApplicationEventPublisherFactory, ArgumentBeanType, BasicObjectRouteMatch, BeanDefinitionWriter, BeanProviderDefinition, BeanRegistration, ClientFilterResolutionContext, ConstructorInterceptorChain, DefaultAnnotationMetadata, DefaultArgument, GenericArgument, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement, InterceptorChain, InterceptorRegistryBean, JakartaProviderBeanDefinition, JavaClassElement, JavaMethodElement, JavaPackageElement, JavaxProviderBeanDefinition, MethodInterceptorChain, MutableAnnotationMetadata, PrimitiveElement

public interface AnnotationSource

A source of annotations. This API provides an alternative to Java's AnnotatedElement that uses the compile time produced data from Micronaut. This is the parent interface of the AnnotationMetadata which provides event more methods to read annotations values and compute Repeatable annotations.

Note that this interface also includes methods such as synthesize(Class) that allows materializing an instance of an annotation by producing a runtime proxy. These methods are a last resort if no other option is possible and should generally be avoided as they require the use of runtime reflection and proxying which hurts performance and memory consumption.

Since:

1.0

Author:

Graeme Rocher

See Also:

AnnotationMetadata

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationSource	EMPTY An empty annotation source.

Method Summary

Modifier and Type	Method and Description
default <T extends Annotation> Optional<AnnotationValue<T>>	findAnnotation(Class<T> annotationClass) Find an AnnotationValue for the given annotation type.
default <T extends Annotation> Optional<AnnotationValue<T>>	findAnnotation(String annotation) Find an AnnotationValue for the given annotation name.
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 <T extends Annotation> Optional<AnnotationValue<T>>	findDeclaredAnnotation(String annotation) Get all of the values for the given annotation that are directly declared on the annotated element.
default <T extends Annotation> AnnotationValue<T>	getAnnotation(Class<T> annotationClass) Find an AnnotationValue for the given annotation name.
default <T extends Annotation> AnnotationValue<T>	getAnnotation(String annotation) Find an AnnotationValue for the given annotation name.
default <T extends Annotation> AnnotationValue<T>	getDeclaredAnnotation(Class<T> annotationClass) Find an AnnotationValue for the given annotation name.
default <T extends Annotation> AnnotationValue<T>	getDeclaredAnnotation(String annotation) Get all of the values for the given annotation that are directly declared on the annotated element.
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 isAnnotationPresent(Class) for declared annotations.
default boolean	isDeclaredAnnotationPresent(String annotationName) Variation of isAnnotationPresent(String) for declared annotations.
default <T extends Annotation> T	synthesize(Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
default <T extends Annotation> T	synthesize(Class<T> annotationClass, String sourceAnnotation) Synthesizes a new annotation for the given annotation type using the member values of the given source annotation.
default Annotation[]	synthesizeAll() Synthesizes a new annotations from the metadata.
default <T extends Annotation> T[]	synthesizeAnnotationsByType(Class<T> annotationClass) Synthesizes a new annotations from the metadata for the given type.
default Annotation[]	synthesizeDeclared() Synthesizes a new annotations from the metadata.
default <T extends Annotation> T	synthesizeDeclared(Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
default <T extends Annotation> T	synthesizeDeclared(Class<T> annotationClass, String sourceAnnotation) Synthesizes a new annotation declared for the given annotation type using the member values of the given source annotation.
default <T extends Annotation> T[]	synthesizeDeclaredAnnotationsByType(Class<T> annotationClass) Synthesizes a new annotations from the metadata for the given type.

Field Detail

EMPTY

static final AnnotationSource EMPTY

An empty annotation source.

Method Detail

synthesize

@Nullable
default <T extends Annotation> T synthesize(@NonNull
                                                      Class<T> annotationClass)

Synthesizes a new annotation from the metadata for the given annotation type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesize

@Nullable
default <T extends Annotation> T synthesize(@NonNull
                                                      Class<T> annotationClass,
                                                      @NonNull
                                                      String sourceAnnotation)

Synthesizes a new annotation for the given annotation type using the member values of the given source annotation.

This method allows supporting synthesizing annotations that have been renamed, for example a jakarta.inject.Named annotation an be synthesized from the metadata of the a javax.inject.Named annotation.

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

sourceAnnotation - The source annotation that provides the member values

Returns:

The annotation or null if it doesn't exist

Since:

3.0.0

synthesizeDeclared

@Nullable
default <T extends Annotation> T synthesizeDeclared(@NonNull
                                                              Class<T> annotationClass,
                                                              @NonNull
                                                              String sourceAnnotation)

Synthesizes a new annotation declared for the given annotation type using the member values of the given source annotation.

This method allows supporting synthesizing annotations that have been renamed, for example a jakarta.inject.Named annotation an be synthesized from the metadata of the a javax.inject.Named annotation.

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

sourceAnnotation - The source annotation that provides the member values

Returns:

The annotation or null if it doesn't exist

Since:

3.0.0

synthesizeDeclared

@Nullable
default <T extends Annotation> T synthesizeDeclared(@NonNull
                                                              Class<T> annotationClass)

Synthesizes a new annotation from the metadata for the given annotation type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesizeAll

@NonNull
default Annotation[] synthesizeAll()

Synthesizes a new annotations from the metadata. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Returns:

All the annotations

synthesizeDeclared

@NonNull
default Annotation[] synthesizeDeclared()

Synthesizes a new annotations from the metadata. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Returns:

All declared annotations

synthesizeAnnotationsByType

@NonNull
default <T extends Annotation> T[] synthesizeAnnotationsByType(@NonNull
                                                                        Class<T> annotationClass)

Synthesizes a new annotations from the metadata for the given type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation type

Returns:

All annotations by the given type

synthesizeDeclaredAnnotationsByType

@NonNull
default <T extends Annotation> T[] synthesizeDeclaredAnnotationsByType(@NonNull
                                                                                Class<T> annotationClass)

Synthesizes a new annotations from the metadata for the given type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation type

Returns:

Declared annotations by the given type

findAnnotation

@NonNull
default <T extends Annotation> Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                    String annotation)

Find an AnnotationValue for the given annotation name.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

findAnnotation

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

Find an AnnotationValue for the given annotation type.

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation

Returns:

A AnnotationValue instance

findDeclaredAnnotation

@NonNull
default <T extends Annotation> Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                            String annotation)

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

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

findDeclaredAnnotation

@NonNull
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.

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

A AnnotationValue instance

getAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getAnnotation(@NonNull
                                                                          String annotation)

Find an AnnotationValue for the given annotation name.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance or null

getAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getAnnotation(@NonNull
                                                                          Class<T> annotationClass)

Find an AnnotationValue for the given annotation name.

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

A AnnotationValue instance or null

getDeclaredAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getDeclaredAnnotation(@NonNull
                                                                                  String annotation)

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

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

getDeclaredAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getDeclaredAnnotation(@NonNull
                                                                                  Class<T> annotationClass)

Find an AnnotationValue for the given annotation name.

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

A AnnotationValue instance or null

isAnnotationPresent

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

Return whether an annotation is present.

Parameters:

annotationClass - The annotation class

Returns:

True if it is

isDeclaredAnnotationPresent

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

Variation of isAnnotationPresent(Class) for declared annotations.

Parameters:

annotationClass - The annotation class

Returns:

True if it is

isAnnotationPresent

default boolean isAnnotationPresent(@NonNull
                                    String annotationName)

Return whether an annotation is present.

Parameters:

annotationName - The annotation name

Returns:

True if it is

isDeclaredAnnotationPresent

default boolean isDeclaredAnnotationPresent(@NonNull
                                            String annotationName)

Variation of isAnnotationPresent(String) for declared annotations.

Parameters:

annotationName - The annotation name

Returns:

True if it is