io.micronaut.inject.annotation

Class AbstractAnnotationMetadataBuilder<T,A>

java.lang.Object

io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder<T,A>

Type Parameters:

T - The element type

A - The annotation type

Direct Known Subclasses:

GroovyAnnotationMetadataBuilder, JavaAnnotationMetadataBuilder

public abstract class AbstractAnnotationMetadataBuilder<T,A>
extends Object

An abstract implementation that builds AnnotationMetadata.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAnnotationMetadataBuilder() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addError(T originatingElement, String error) Adds an error.
static void	addMutatedMetadata(String declaringType, Object element, AnnotationMetadata metadata) Used to store metadata mutations at compilation time.
protected abstract void	addWarning(T originatingElement, String warning) Adds an warning.
<A2 extends Annotation> AnnotationMetadata	annotate(AnnotationMetadata annotationMetadata, AnnotationValue<A2> annotationValue) Annotate an existing annotation metadata object.
AnnotationMetadata	build(String declaringType, T element) Build the meta data for the given element.
AnnotationMetadata	build(T element) Build the meta data for the given element.
AnnotationMetadata	buildDeclared(T element) Build only metadata for declared annotations.
AnnotationMetadata	buildDeclared(T element, List<? extends A> annotations, boolean includeTypeAnnotations) Build only metadata for declared annotations.
AnnotationMetadata	buildForMethod(T element) Build the meta data for the given method element excluding any class metadata.
AnnotationMetadata	buildForParent(String declaringType, T parent, T element) Build the meta data for the given parent and method element excluding any class metadata.
AnnotationMetadata	buildForParent(T parent, T element) Get the annotation metadata for the given element and the given parent.
AnnotationMetadata	buildForParent(T parent, T element, boolean inheritTypeAnnotations) Build the meta data for the given method element excluding any class metadata.
AnnotationMetadata	buildForParents(List<T> parents, T element) Get the annotation metadata for the given element and the given parents.
AnnotationMetadata	buildForParents(String declaringType, List<T> parents, T element) Build the meta data for the given parents and method element excluding any class metadata.
protected abstract List<T>	buildHierarchy(T element, boolean inheritTypeAnnotations, boolean declaredOnly) Build the type hierarchy for the given element.
AnnotationMetadata	buildOverridden(T element) Build metadata for the given element, including any metadata that is inherited via method or type overrides.
static void	clearCaches() Used to clear caches at the end of a compilation cycle.
static void	clearMutated() Used to clear mutated metadata at the end of a compilation cycle.
static void	copyToRuntime() This is used for testing scenarios only where annotation metadata is created without bean creation.
protected abstract VisitorContext	createVisitorContext() Creates the visitor context for this implementation.
protected List<AnnotationMapper<? extends Annotation>>	getAnnotationMappers(String annotationName) Obtain the annotation mappers for the given annotation name.
protected abstract T	getAnnotationMember(T originatingElement, CharSequence member) Get the annotation member.
protected abstract String	getAnnotationMemberName(T member) Read the name of an annotation member.
protected abstract Map<String,? extends T>	getAnnotationMembers(String annotationType) Gets the annotation members for the given type.
protected abstract Optional<T>	getAnnotationMirror(String annotationName) Return a mirror for the given annotation.
protected abstract List<? extends A>	getAnnotationsForType(T element) Obtain the annotations for the given type.
protected List<AnnotationTransformer<Annotation>>	getAnnotationTransformers(String annotationName) Obtain the transformers mappers for the given annotation name.
protected abstract String	getAnnotationTypeName(A annotationMirror) Get the given type of the annotation.
protected abstract OptionalValues<?>	getAnnotationValues(T originatingElement, T member, Class<?> annotationType) Resolve the annotations values from the given member for the given type.
protected abstract String	getDeclaringType(T element) Obtains the declaring type for an element.
protected abstract String	getElementName(T element) Get the name for the given element.
protected AnnotatedElementValidator	getElementValidator() Obtains the element validator.
static Set<String>	getMappedAnnotationNames()
static Set<String>	getMappedAnnotationPackages()
protected abstract String	getRepeatableName(A annotationMirror) Obtain the name of the repeatable annotation if the annotation is is one.
protected abstract String	getRepeatableNameForType(T annotationType) Obtain the name of the repeatable annotation if the annotation is is one.
protected abstract RetentionPolicy	getRetentionPolicy(T annotation) Gets the retention policy for the given annotation.
protected abstract T	getTypeForAnnotation(A annotationMirror) Get the type of the given annotation.
protected abstract boolean	hasAnnotation(T element, Class<? extends Annotation> annotation) Checks whether an annotation is present.
protected abstract boolean	hasAnnotation(T element, String annotation) Checks whether an annotation is present.
protected abstract boolean	hasAnnotations(T element) Checks whether any annotations are present on the given element.
protected abstract boolean	hasSimpleAnnotation(T element, String simpleName) Returns true if a simple meta annotation is present for the given element and annotation type.
static boolean	isAnnotationMapped(String annotationName) Returns whether the given annotation is a mapped annotation.
protected boolean	isExcludedAnnotation(T element, String annotationName) Is the given annotation excluded for the specified element.
protected abstract boolean	isInheritedAnnotation(A annotationMirror) Test whether the annotation mirror is inherited.
protected abstract boolean	isInheritedAnnotationType(T annotationType) Test whether the annotation mirror is inherited.
static boolean	isMetadataMutated(String declaringType, Object element) Used to store metadata mutations at compilation time.
protected abstract boolean	isMethodOrClassElement(T element) Whether the element is a field, method, class or constructor.
protected abstract boolean	isValidationRequired(T member) Return whether the given member requires validation.
protected Map<CharSequence,Object>	populateAnnotationData(T originatingElement, boolean originatingElementIsSameParent, A annotationMirror, DefaultAnnotationMetadata metadata, boolean isDeclared, RetentionPolicy retentionPolicy, boolean allowAliases) Populate the annotation data for the given annotation.
protected Map<CharSequence,Object>	populateAnnotationData(T originatingElement, T parent, A annotationMirror, DefaultAnnotationMetadata metadata, boolean isDeclared, RetentionPolicy retentionPolicy, boolean allowAliases) Populate the annotation data for the given annotation.
protected abstract Map<? extends T,?>	readAnnotationDefaultValues(A annotationMirror) Read the raw default annotation values from the given annotation.
protected abstract Map<? extends T,?>	readAnnotationDefaultValues(String annotationName, T annotationType) Read the raw default annotation values from the given annotation.
protected abstract Map<? extends T,?>	readAnnotationRawValues(A annotationMirror) Read the raw annotation values from the given annotation.
protected abstract void	readAnnotationRawValues(T originatingElement, String annotationName, T member, String memberName, Object annotationValue, Map<CharSequence,Object> annotationValues) Read the given member and value, applying conversions if necessary, and place the data in the given map.
protected abstract Object	readAnnotationValue(T originatingElement, T member, String memberName, Object annotationValue) Read the given member and value, applying conversions if necessary, and place the data in the given map.
protected AnnotationValue	readNestedAnnotationValue(T originatingElement, A annotationMirror)
AnnotationMetadata	removeAnnotation(AnnotationMetadata annotationMetadata, String annotationType) Removes an annotation from the given annotation metadata.
<T1 extends Annotation> AnnotationMetadata	removeAnnotationIf(AnnotationMetadata annotationMetadata, Predicate<AnnotationValue<T1>> predicate) Removes an annotation from the metadata for the given predicate.
AnnotationMetadata	removeStereotype(AnnotationMetadata annotationMetadata, String annotationType) Removes an annotation from the given annotation metadata.
protected void	validateAnnotationValue(T originatingElement, String annotationName, T member, String memberName, Object resolvedValue) Validates an annotation value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAnnotationMetadataBuilder

protected AbstractAnnotationMetadataBuilder()

Default constructor.

Method Detail

buildDeclared

public AnnotationMetadata buildDeclared(T element)

Build only metadata for declared annotations.

Parameters:

element - The element

Returns:

The AnnotationMetadata

buildDeclared

public AnnotationMetadata buildDeclared(T element,
                                        List<? extends A> annotations,
                                        boolean includeTypeAnnotations)

Build only metadata for declared annotations.

Parameters:

element - The element

annotations - The annotations

includeTypeAnnotations - Whether to include type level annotations in the metadata for the element

Returns:

The AnnotationMetadata

buildOverridden

public AnnotationMetadata buildOverridden(T element)

Build metadata for the given element, including any metadata that is inherited via method or type overrides.

Parameters:

element - The element

Returns:

The AnnotationMetadata

build

public AnnotationMetadata build(T element)

Build the meta data for the given element. If the element is a method the class metadata will be included.

Parameters:

element - The element

Returns:

The AnnotationMetadata

build

public AnnotationMetadata build(String declaringType,
                                T element)

Build the meta data for the given element. If the element is a method the class metadata will be included.

Parameters:

declaringType - The declaring type

element - The element

Returns:

The AnnotationMetadata

isMethodOrClassElement

protected abstract boolean isMethodOrClassElement(T element)

Whether the element is a field, method, class or constructor.

Parameters:

element - The element

Returns:

True if it is

getDeclaringType

@Nullable
protected abstract String getDeclaringType(@NonNull
                                                     T element)

Obtains the declaring type for an element.

Parameters:

element - The element

Returns:

The declaring type

buildForMethod

public AnnotationMetadata buildForMethod(T element)

Build the meta data for the given method element excluding any class metadata.

Parameters:

element - The element

Returns:

The AnnotationMetadata

buildForParent

public AnnotationMetadata buildForParent(T parent,
                                         T element)

Get the annotation metadata for the given element and the given parent. This method is used for cases when you need to combine annotation metadata for two elements, for example a JavaBean property where the field and the method metadata need to be combined.

Parameters:

parent - The parent element

element - The element

Returns:

The AnnotationMetadata

buildForParents

public AnnotationMetadata buildForParents(List<T> parents,
                                          T element)

Get the annotation metadata for the given element and the given parents. This method is used for cases when you need to combine annotation metadata for two elements, for example a JavaBean property where the field and the method metadata need to be combined.

Parameters:

parents - The parent elements

element - The element

Returns:

The AnnotationMetadata

buildForParent

public AnnotationMetadata buildForParent(String declaringType,
                                         T parent,
                                         T element)

Build the meta data for the given parent and method element excluding any class metadata.

Parameters:

declaringType - The declaring type

parent - The parent element

element - The element

Returns:

The AnnotationMetadata

buildForParents

public AnnotationMetadata buildForParents(String declaringType,
                                          List<T> parents,
                                          T element)

Build the meta data for the given parents and method element excluding any class metadata.

Parameters:

declaringType - The declaring type

parents - The parent elements

element - The element

Returns:

The AnnotationMetadata

buildForParent

public AnnotationMetadata buildForParent(T parent,
                                         T element,
                                         boolean inheritTypeAnnotations)

Build the meta data for the given method element excluding any class metadata.

Parameters:

parent - The parent element

element - The element

inheritTypeAnnotations - Whether to inherit annotations from type as stereotypes

Returns:

The AnnotationMetadata

getTypeForAnnotation

protected abstract T getTypeForAnnotation(A annotationMirror)

Get the type of the given annotation.

Parameters:

annotationMirror - The annotation

Returns:

The type

hasAnnotation

protected abstract boolean hasAnnotation(T element,
                                         Class<? extends Annotation> annotation)

Checks whether an annotation is present.

Parameters:

element - The element

annotation - The annotation type

Returns:

True if the annotation is present

hasAnnotation

protected abstract boolean hasAnnotation(T element,
                                         String annotation)

Checks whether an annotation is present.

Parameters:

element - The element

annotation - The annotation type name

Returns:

True if the annotation is present

hasAnnotations

protected abstract boolean hasAnnotations(T element)

Checks whether any annotations are present on the given element.

Parameters:

element - The element

Returns:

True if the annotation is present

getAnnotationTypeName

protected abstract String getAnnotationTypeName(A annotationMirror)

Get the given type of the annotation.

Parameters:

annotationMirror - The annotation

Returns:

The type

getElementName

protected abstract String getElementName(T element)

Get the name for the given element.

Parameters:

element - The element

Returns:

The name

getAnnotationsForType

protected abstract List<? extends A> getAnnotationsForType(T element)

Obtain the annotations for the given type. This method is also responsible for unwrapping repeatable annotations. For example, @Parent(value = {@Child, @Child}) should result in the two child annotations being returned from this method instead of the parent annotation.

Parameters:

element - The type element

Returns:

The annotations

buildHierarchy

protected abstract List<T> buildHierarchy(T element,
                                          boolean inheritTypeAnnotations,
                                          boolean declaredOnly)

Build the type hierarchy for the given element.

Parameters:

element - The element

inheritTypeAnnotations - Whether to inherit type annotations

declaredOnly - Whether to only include declared annotations

Returns:

The type hierarchy

readAnnotationRawValues

protected abstract void readAnnotationRawValues(T originatingElement,
                                                String annotationName,
                                                T member,
                                                String memberName,
                                                Object annotationValue,
                                                Map<CharSequence,Object> annotationValues)

Read the given member and value, applying conversions if necessary, and place the data in the given map.

Parameters:

originatingElement - The originating element

annotationName - The annotation name

member - The member being read from

memberName - The member

annotationValue - The value

annotationValues - The values to populate

validateAnnotationValue

protected void validateAnnotationValue(T originatingElement,
                                       String annotationName,
                                       T member,
                                       String memberName,
                                       Object resolvedValue)

Validates an annotation value.

Parameters:

originatingElement - The originating element

annotationName - The annotation name

member - The member

memberName - The member name

resolvedValue - The resolved value

isValidationRequired

protected abstract boolean isValidationRequired(T member)

Return whether the given member requires validation.

Parameters:

member - The member

Returns:

True if it is

getElementValidator

@Nullable
protected AnnotatedElementValidator getElementValidator()

Obtains the element validator.

Returns:

The validator.

addError

protected abstract void addError(@NonNull
                                 T originatingElement,
                                 @NonNull
                                 String error)

Adds an error.

Parameters:

originatingElement - The originating element

error - The error

addWarning

protected abstract void addWarning(@NonNull
                                   T originatingElement,
                                   @NonNull
                                   String warning)

Adds an warning.

Parameters:

originatingElement - The originating element

warning - The warning

readAnnotationValue

protected abstract Object readAnnotationValue(T originatingElement,
                                              T member,
                                              String memberName,
                                              Object annotationValue)

Read the given member and value, applying conversions if necessary, and place the data in the given map.

Parameters:

originatingElement - The originating element

member - The member

memberName - The member name

annotationValue - The value

Returns:

The object

readAnnotationDefaultValues

protected abstract Map<? extends T,?> readAnnotationDefaultValues(A annotationMirror)

Read the raw default annotation values from the given annotation.

Parameters:

annotationMirror - The annotation

Returns:

The values

readAnnotationDefaultValues

protected abstract Map<? extends T,?> readAnnotationDefaultValues(String annotationName,
                                                                  T annotationType)

Read the raw default annotation values from the given annotation.

Parameters:

annotationName - annotation name

annotationType - the type

Returns:

The values

readAnnotationRawValues

protected abstract Map<? extends T,?> readAnnotationRawValues(A annotationMirror)

Read the raw annotation values from the given annotation.

Parameters:

annotationMirror - The annotation

Returns:

The values

getAnnotationValues

protected abstract OptionalValues<?> getAnnotationValues(T originatingElement,
                                                         T member,
                                                         Class<?> annotationType)

Resolve the annotations values from the given member for the given type.

Parameters:

originatingElement - The originating element

member - The member

annotationType - The type

Returns:

The values

getAnnotationMemberName

protected abstract String getAnnotationMemberName(T member)

Read the name of an annotation member.

Parameters:

member - The member

Returns:

The name

getRepeatableName

@Nullable
protected abstract String getRepeatableName(A annotationMirror)

Obtain the name of the repeatable annotation if the annotation is is one.

Parameters:

annotationMirror - The annotation mirror

Returns:

Return the name or null

getRepeatableNameForType

@Nullable
protected abstract String getRepeatableNameForType(T annotationType)

Obtain the name of the repeatable annotation if the annotation is is one.

Parameters:

annotationType - The annotation mirror

Returns:

Return the name or null

readNestedAnnotationValue

protected AnnotationValue readNestedAnnotationValue(T originatingElement,
                                                    A annotationMirror)

Parameters:

originatingElement - The originating element

annotationMirror - The annotation

Returns:

The annotation value

getAnnotationMirror

protected abstract Optional<T> getAnnotationMirror(String annotationName)

Return a mirror for the given annotation.

Parameters:

annotationName - The annotation name

Returns:

An optional mirror

populateAnnotationData

protected Map<CharSequence,Object> populateAnnotationData(T originatingElement,
                                                          @Nullable
                                                          T parent,
                                                          A annotationMirror,
                                                          DefaultAnnotationMetadata metadata,
                                                          boolean isDeclared,
                                                          RetentionPolicy retentionPolicy,
                                                          boolean allowAliases)

Populate the annotation data for the given annotation.

Parameters:

originatingElement - The element the annotation data originates from

parent - The parent element

annotationMirror - The annotation

metadata - the metadata

isDeclared - Is the annotation a declared annotation

retentionPolicy - The retention policy

allowAliases - Whether aliases are allowed

Returns:

The annotation values

populateAnnotationData

protected Map<CharSequence,Object> populateAnnotationData(T originatingElement,
                                                          boolean originatingElementIsSameParent,
                                                          A annotationMirror,
                                                          DefaultAnnotationMetadata metadata,
                                                          boolean isDeclared,
                                                          RetentionPolicy retentionPolicy,
                                                          boolean allowAliases)

Populate the annotation data for the given annotation.

Parameters:

originatingElement - The element the annotation data originates from

originatingElementIsSameParent - Whether the originating element is considered a parent element

annotationMirror - The annotation

metadata - the metadata

isDeclared - Is the annotation a declared annotation

retentionPolicy - The retention policy

allowAliases - Whether aliases are allowed

Returns:

The annotation values

getAnnotationMember

@Nullable
protected abstract T getAnnotationMember(T originatingElement,
                                                   CharSequence member)

Get the annotation member.

Parameters:

originatingElement - The originatig element

member - The member

Returns:

The annotation member

getAnnotationMappers

@NonNull
protected List<AnnotationMapper<? extends Annotation>> getAnnotationMappers(@NonNull
                                                                                     String annotationName)

Obtain the annotation mappers for the given annotation name.

Parameters:

annotationName - The annotation name

Returns:

The mappers

getAnnotationTransformers

@NonNull
protected List<AnnotationTransformer<Annotation>> getAnnotationTransformers(@NonNull
                                                                                     String annotationName)

Obtain the transformers mappers for the given annotation name.

Parameters:

annotationName - The annotation name

Returns:

The transformers

createVisitorContext

protected abstract VisitorContext createVisitorContext()

Creates the visitor context for this implementation.

Returns:

The visitor context

getRetentionPolicy

@NonNull
protected abstract RetentionPolicy getRetentionPolicy(@NonNull
                                                               T annotation)

Gets the retention policy for the given annotation.

Parameters:

annotation - The annotation

Returns:

The retention policy

isExcludedAnnotation

protected boolean isExcludedAnnotation(@NonNull
                                       T element,
                                       @NonNull
                                       String annotationName)

Is the given annotation excluded for the specified element.

Parameters:

element - The element

annotationName - The annotation name

Returns:

True if it is excluded

isInheritedAnnotation

protected abstract boolean isInheritedAnnotation(@NonNull
                                                 A annotationMirror)

Test whether the annotation mirror is inherited.

Parameters:

annotationMirror - The mirror

Returns:

True if it is

isInheritedAnnotationType

protected abstract boolean isInheritedAnnotationType(@NonNull
                                                     T annotationType)

Test whether the annotation mirror is inherited.

Parameters:

annotationType - The mirror

Returns:

True if it is

getAnnotationMembers

@NonNull
protected abstract Map<String,? extends T> getAnnotationMembers(@NonNull
                                                                         String annotationType)

Gets the annotation members for the given type.

Parameters:

annotationType - The annotation type

Returns:

The members

Since:

3.3.0

hasSimpleAnnotation

protected abstract boolean hasSimpleAnnotation(T element,
                                               String simpleName)

Returns true if a simple meta annotation is present for the given element and annotation type.

Parameters:

element - The element

simpleName - The simple name, ie Class.getSimpleName()

Returns:

True an annotation with the given simple name exists on the element

addMutatedMetadata

@Internal
public static void addMutatedMetadata(String declaringType,
                                                Object element,
                                                AnnotationMetadata metadata)

Used to store metadata mutations at compilation time. Not for public consumption.

Parameters:

declaringType - The declaring type

element - The element

metadata - The metadata

isMetadataMutated

@Internal
public static boolean isMetadataMutated(String declaringType,
                                                  Object element)

Used to store metadata mutations at compilation time. Not for public consumption.

Parameters:

declaringType - The declaring type

element - The element

Returns:

True if the annotation metadata was mutated

clearMutated

@Internal
public static void clearMutated()

Used to clear mutated metadata at the end of a compilation cycle.

clearCaches

@Internal
public static void clearCaches()

Used to clear caches at the end of a compilation cycle.

copyToRuntime

@Internal
public static void copyToRuntime()

This is used for testing scenarios only where annotation metadata is created without bean creation. It is needed because at compile time there are no defaults added via DefaultAnnotationMetadata.

isAnnotationMapped

@Internal
public static boolean isAnnotationMapped(@Nullable
                                                   String annotationName)

Returns whether the given annotation is a mapped annotation.

Parameters:

annotationName - The annotation name

Returns:

True if it is

getMappedAnnotationNames

@Internal
public static Set<String> getMappedAnnotationNames()

Returns:

Additional mapped annotation names

getMappedAnnotationPackages

@Internal
public static Set<String> getMappedAnnotationPackages()

Returns:

Additional mapped annotation names

annotate

public <A2 extends Annotation> AnnotationMetadata annotate(AnnotationMetadata annotationMetadata,
                                                           AnnotationValue<A2> annotationValue)

Annotate an existing annotation metadata object.

Type Parameters:

A2 - The annotation type

Parameters:

annotationMetadata - The annotation metadata

annotationValue - The annotation value

Returns:

The mutated metadata

removeAnnotation

public AnnotationMetadata removeAnnotation(AnnotationMetadata annotationMetadata,
                                           String annotationType)

Removes an annotation from the given annotation metadata.

Parameters:

annotationMetadata - The annotation metadata

annotationType - The annotation type

Returns:

The updated metadata

Since:

3.0.0

removeStereotype

public AnnotationMetadata removeStereotype(AnnotationMetadata annotationMetadata,
                                           String annotationType)

Removes an annotation from the given annotation metadata.

Parameters:

annotationMetadata - The annotation metadata

annotationType - The annotation type

Returns:

The updated metadata

Since:

3.0.0

removeAnnotationIf

@NonNull
public <T1 extends Annotation> AnnotationMetadata removeAnnotationIf(@NonNull
                                                                              AnnotationMetadata annotationMetadata,
                                                                              @NonNull
                                                                              Predicate<AnnotationValue<T1>> predicate)

Removes an annotation from the metadata for the given predicate.

Type Parameters:

T1 - The annotation type

Parameters:

annotationMetadata - The annotation metadata

predicate - The predicate

Returns:

The potentially modified metadata