io.micronaut.core.annotation

Interface AnnotationSource

All Known Subinterfaces:

AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, Argument<T>, ArgumentConversionContext<T>, ArgumentValue<V>, BeanConfiguration, BeanDefinition<T>, BeanDefinitionMethodReference<T,R>, BeanDefinitionReference<T>, BeanType<T>, BoundExecutable<T,R>, CallableInjectionPoint, 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<T>, InitializingBeanDefinition<T>, InjectionPoint, InvocationContext<T,R>, MethodBasedRouteMatch<T,R>, MethodElement, MethodExecutionHandle<T,R>, MethodInjectionPoint, MethodInvocationContext<T,R>, MethodReference<T,R>, MutableArgumentValue<V>, ParameterElement, PropertyElement, ProxyBeanDefinition<T>, ReturnType<T>, RouteMatch<R>, TypedElement, UriRouteMatch<T,R>, ValidatedBeanDefinition<T>

All Known Implementing Classes:

AbstractBeanConfiguration, AbstractBeanDefinition, AbstractBeanDefinitionReference, AbstractEnvironmentAnnotationMetadata, AbstractExecutableMethod, io.micronaut.ast.groovy.visitor.AbstractGroovyElement, AbstractJavaElement, AbstractParametrizedBeanDefinition, AnnotationMetadataReference, BasicObjectRouteMatch, DefaultAnnotationMetadata, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyParameterElement, InterceptorChain, JavaClassElement, JavaConstructorElement, JavaParameterElement, JavaPrimitiveElement, MethodInterceptorChain

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> annotation) 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> annotation) 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> annotation) 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> annotation) 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	isDeclaredAnnotationPresent(Class<? extends Annotation> annotationClass) Variation of isAnnotationPresent(Class) 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 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[]	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

default <T extends Annotation> T synthesize(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

default <T extends Annotation> T synthesizeDeclared(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

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

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

default <T extends Annotation> T[] synthesizeAnnotationsByType(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

default <T extends Annotation> T[] synthesizeDeclaredAnnotationsByType(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

default <T extends Annotation> Optional<AnnotationValue<T>> findAnnotation(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

default <T extends Annotation> Optional<AnnotationValue<T>> findAnnotation(Class<T> annotation)

Find an AnnotationValue for the given annotation type.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation

Returns:

A AnnotationValue instance

findDeclaredAnnotation

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.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

findDeclaredAnnotation

default <T extends Annotation> Optional<AnnotationValue<T>> findDeclaredAnnotation(Class<T> 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

getAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getAnnotation(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(Class<T> 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

getDeclaredAnnotation

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

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

getDeclaredAnnotation

@Nullable
default <T extends Annotation> AnnotationValue<T> getDeclaredAnnotation(Class<T> 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

isAnnotationPresent

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

Return whether an annotation is present.

Parameters:

annotationClass - The annotation class

Returns:

True if it is

isDeclaredAnnotationPresent

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

Variation of isAnnotationPresent(Class) for declared annotations.

Parameters:

annotationClass - The annotation class

Returns:

True if it is