io.micronaut.core.annotation

Interface AnnotationSource

All Known Subinterfaces:

AdvisedBeanType<T>, AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, Argument<T>, ArgumentConversionContext<T>, ArgumentInjectionPoint<B,T>, ArgumentValue<V>, ArrayableClassElement, BeanConfiguration, BeanDefinition<T>, BeanDefinitionMethodReference<T,R>, BeanDefinitionReference<T>, BeanIntrospection<T>, BeanIntrospectionReference<T>, BeanProperty<B,T>, BeanType<T>, BeanWrapper<T>, BoundExecutable<T,R>, CallableInjectionPoint<T>, ClassElement, ConstructorElement, ConstructorInjectionPoint<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, HttpFilterResolver.FilterEntry<F>, InitializingBeanDefinition<T>, InjectionPoint<T>, InvocationContext<T,R>, MemberElement, MethodBasedRouteMatch<T,R>, MethodElement, MethodExecutionHandle<T,R>, MethodInjectionPoint<B,T>, MethodInvocationContext<T,R>, MethodReference<T,R>, MutableArgumentValue<V>, ParameterElement, PropertyElement, ProxyBeanDefinition<T>, ReturnType<T>, RouteInfo<R>, RouteMatch<R>, TypedElement, UriRouteMatch<T,R>, ValidatedBeanDefinition<T>

All Known Implementing Classes:

AbstractBeanConfiguration, AbstractBeanDefinition, AbstractBeanDefinitionReference, AbstractBeanIntrospection, AbstractBeanIntrospectionReference, AbstractBeanProperty, AbstractEnvironmentAnnotationMetadata, AbstractExecutableMethod, AbstractGroovyElement, AbstractJavaElement, AbstractParametrizedBeanDefinition, AnnotationMetadataHierarchy, AnnotationMetadataReference, ArgumentBeanType, BasicObjectRouteMatch, ClientFilterResolutionContext, DefaultAnnotationMetadata, DefaultArgument, GenericArgument, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement, InterceptorChain, JavaClassElement, JavaMethodElement, JavaPackageElement, MethodInterceptorChain, 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 java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findAnnotation(java.lang.Class<T> annotationClass) Find an AnnotationValue for the given annotation type.
default <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findAnnotation(java.lang.String annotation) Find an AnnotationValue for the given annotation name.
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 <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findDeclaredAnnotation(java.lang.String annotation) Get all of the values for the given annotation that are directly declared on the annotated element.
default <T extends java.lang.annotation.Annotation> AnnotationValue<T>	getAnnotation(java.lang.Class<T> annotationClass) Find an AnnotationValue for the given annotation name.
default <T extends java.lang.annotation.Annotation> AnnotationValue<T>	getAnnotation(java.lang.String annotation) Find an AnnotationValue for the given annotation name.
default <T extends java.lang.annotation.Annotation> AnnotationValue<T>	getDeclaredAnnotation(java.lang.Class<T> annotationClass) Find an AnnotationValue for the given annotation name.
default <T extends java.lang.annotation.Annotation> AnnotationValue<T>	getDeclaredAnnotation(java.lang.String annotation) Get all of the values for the given annotation that are directly declared on the annotated element.
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 isAnnotationPresent(Class) for declared annotations.
default <T extends java.lang.annotation.Annotation> T	synthesize(java.lang.Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
default java.lang.annotation.Annotation[]	synthesizeAll() Synthesizes a new annotations from the metadata.
default <T extends java.lang.annotation.Annotation> T[]	synthesizeAnnotationsByType(java.lang.Class<T> annotationClass) Synthesizes a new annotations from the metadata for the given type.
default java.lang.annotation.Annotation[]	synthesizeDeclared() Synthesizes a new annotations from the metadata.
default <T extends java.lang.annotation.Annotation> T	synthesizeDeclared(java.lang.Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
default <T extends java.lang.annotation.Annotation> T[]	synthesizeDeclaredAnnotationsByType(java.lang.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 java.lang.annotation.Annotation> T synthesize(@NonNull
                                                                           java.lang.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

synthesizeDeclared

@Nullable
default <T extends java.lang.annotation.Annotation> T synthesizeDeclared(@NonNull
                                                                                   java.lang.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 java.lang.annotation.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 java.lang.annotation.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 java.lang.annotation.Annotation> T[] synthesizeAnnotationsByType(@NonNull
                                                                                             java.lang.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 java.lang.annotation.Annotation> T[] synthesizeDeclaredAnnotationsByType(@NonNull
                                                                                                     java.lang.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 java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                                                   java.lang.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 java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                                                   java.lang.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 java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                                                           java.lang.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 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.

Type Parameters:

T - The annotation type

Parameters:

annotationClass - The annotation name

Returns:

A AnnotationValue instance

getAnnotation

@Nullable
default <T extends java.lang.annotation.Annotation> AnnotationValue<T> getAnnotation(@NonNull
                                                                                               java.lang.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 java.lang.annotation.Annotation> AnnotationValue<T> getAnnotation(@NonNull
                                                                                               java.lang.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 java.lang.annotation.Annotation> AnnotationValue<T> getDeclaredAnnotation(@NonNull
                                                                                                       java.lang.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 java.lang.annotation.Annotation> AnnotationValue<T> getDeclaredAnnotation(@NonNull
                                                                                                       java.lang.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
                                    java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Return whether an annotation is present.

Parameters:

annotationClass - The annotation class

Returns:

True if it is

isDeclaredAnnotationPresent

default boolean isDeclaredAnnotationPresent(@NonNull
                                            java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Variation of isAnnotationPresent(Class) for declared annotations.

Parameters:

annotationClass - The annotation class

Returns:

True if it is