Package io.micronaut.annotation.processing

Class JavaAnnotationMetadataBuilder

java.lang.Object

io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

io.micronaut.annotation.processing.JavaAnnotationMetadataBuilder

public class JavaAnnotationMetadataBuilder
extends AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

A AnnotationMetadata for builder for Java to be used at compile time.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder

AbstractAnnotationMetadataBuilder.CachedAnnotationMetadata

Field Summary

Fields inherited from class io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder

ELEMENT_VALIDATOR

Constructor Summary

Constructors

Constructor	Description
JavaAnnotationMetadataBuilder(Elements elements, Messager messager, AnnotationUtils annotationUtils, ModelUtils modelUtils)	Deprecated, for removal: This API element is subject to removal in a future version. Not needed
JavaAnnotationMetadataBuilder(Elements elements, Messager messager, ModelUtils modelUtils, JavaNativeElementsHelper nativeElementsHelper, JavaVisitorContext visitorContext)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addError(@NonNull Element originatingElement, @NonNull String error)	Adds an error.
protected void	addWarning(@NonNull Element originatingElement, @NonNull String warning)	Adds a warning.
protected List<Element>	buildHierarchy(Element element, boolean inheritTypeAnnotations, boolean declaredOnly)	Build the type hierarchy for the given element.
static void	clearCaches()	Clears any caches from the last compilation round.
protected @Nullable Element	getAnnotationMember(Element annotationElement, CharSequence member)	Get the annotation member.
protected String	getAnnotationMemberName(Element member)	Read the name of an annotation member.
protected Optional<Element>	getAnnotationMirror(String annotationName)	Return a mirror for the given annotation.
protected List<? extends AnnotationMirror>	getAnnotationsForType(Element element)	Obtain the annotations for the given type.
protected String	getAnnotationTypeName(AnnotationMirror annotationMirror)	Get the given type of the annotation.
protected <K extends Annotation> Optional<AnnotationValue<K>>	getAnnotationValues(Element originatingElement, Element member, Class<K> annotationType)	Resolve the annotations values from the given member for the given type.
protected String	getElementName(Element element)	Get the name for the given element.
protected String	getOriginatingClassName(@NonNull Element orginatingElement)
protected @Nullable String	getRepeatableContainerNameForType(Element annotationType)	Obtain the name of the repeatable annotation if the annotation is one.
protected @Nullable String	getRepeatableName(AnnotationMirror annotationMirror)	Obtain the name of the repeatable annotation if the annotation is one.
protected @NonNull RetentionPolicy	getRetentionPolicy(@NonNull Element annotation)	Gets the retention policy for the given annotation.
protected Element	getTypeForAnnotation(AnnotationMirror annotationMirror)	Get the type of the given annotation.
protected VisitorContext	getVisitorContext()	Returns the visitor context for this implementation.
boolean	hasAnnotation(Element element, Class<? extends Annotation> ann)	Checks if a method has an annotation.
boolean	hasAnnotation(Element element, String ann)	Checks if a method has an annotation.
static boolean	hasAnnotation(ExecutableElement method, Class<? extends Annotation> ann)	Checks if a method has an annotation.
protected boolean	hasAnnotations(Element element)	Checks whether any annotations are present on the given element.
protected boolean	isExcludedAnnotation(@NonNull Element element, @NonNull String annotationName)	Is the given annotation excluded for the specified element.
protected boolean	isValidationRequired(Element member)	Return whether the given member requires validation.
protected Map<? extends Element,?>	readAnnotationDefaultValues(String annotationTypeName, Element element)	Read the raw default annotation values from the given annotation.
protected Map<? extends Element,?>	readAnnotationRawValues(AnnotationMirror annotationMirror)	Read the raw annotation values from the given annotation.
protected void	readAnnotationRawValues(Element originatingElement, String annotationName, Element 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 void	readAnnotationRawValues(Element originatingElement, String annotationName, Element member, String memberName, Object annotationValue, Map<CharSequence,Object> annotationValues, Map<String,Map<CharSequence,Object>> resolvedDefaults)	Read the given member and value, applying conversions if necessary, and place the data in the given map.
protected Object	readAnnotationValue(Element originatingElement, Element member, String annotationName, String memberName, Object annotationValue)	Read the given member and value, applying conversions if necessary, and place the data in the given map.

Methods inherited from class io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder

annotate, buildDeclared, buildEvaluatedExpressionReference, clearMutated, clearMutated, copyToRuntime, findRepeatableContainerNameForType, getAnnotationMappers, getAnnotationTransformers, getCachedAnnotationDefaults, getElementValidator, getMappedAnnotationNames, getMappedAnnotationPackages, getRetentionPolicy, isEvaluatedExpression, isRepeatableAnnotationContainer, lookupOrBuild, lookupOrBuildForField, lookupOrBuildForMethod, lookupOrBuildForParameter, lookupOrBuildForType, postProcess, readNestedAnnotationValue, readNestedAnnotationValue, removeAnnotation, removeAnnotationIf, removeStereotype, validateAnnotationValue

Methods inherited from class java.lang.Object

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

Constructor Details

JavaAnnotationMetadataBuilder

@Deprecated(forRemoval=true,
            since="4.3.0")
public JavaAnnotationMetadataBuilder(Elements elements,
 Messager messager,
 AnnotationUtils annotationUtils,
 ModelUtils modelUtils)

Deprecated, for removal: This API element is subject to removal in a future version.

Not needed

Default constructor.

Parameters:

elements - The elementUtils

messager - The messager

annotationUtils - The annotation utils

modelUtils - The model utils

JavaAnnotationMetadataBuilder

public JavaAnnotationMetadataBuilder(Elements elements,
 Messager messager,
 ModelUtils modelUtils,
 JavaNativeElementsHelper nativeElementsHelper,
 JavaVisitorContext visitorContext)

Default constructor.

Parameters:

elements - The elementUtils

messager - The messager

modelUtils - The model utils

nativeElementsHelper - The native elements helper

visitorContext - The visitor context

Method Details

addError

protected void addError(@NonNull
 @NonNull Element originatingElement,
 @NonNull
 @NonNull String error)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds an error.

Specified by:

addError in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

originatingElement - The originating element

error - The error

addWarning

protected void addWarning(@NonNull
 @NonNull Element originatingElement,
 @NonNull
 @NonNull String warning)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds a warning.

Specified by:

addWarning in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

originatingElement - The originating element

warning - The warning

getAnnotationMemberName

protected String getAnnotationMemberName(Element member)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the name of an annotation member.

Specified by:

getAnnotationMemberName in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

member - The member

Returns:

The name

getRepeatableName

@Nullable
protected @Nullable String getRepeatableName(AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableName in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationMirror - The annotation mirror

Returns:

Return the name or null

getRepeatableContainerNameForType

@Nullable
protected @Nullable String getRepeatableContainerNameForType(Element annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableContainerNameForType in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationType - The annotation mirror

Returns:

Return the name or null

getAnnotationMirror

protected Optional<Element> getAnnotationMirror(String annotationName)

Description copied from class: AbstractAnnotationMetadataBuilder

Return a mirror for the given annotation.

Specified by:

getAnnotationMirror in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationName - The annotation name

Returns:

An optional mirror

getVisitorContext

protected VisitorContext getVisitorContext()

Description copied from class: AbstractAnnotationMetadataBuilder

Returns the visitor context for this implementation.

Specified by:

getVisitorContext in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Returns:

The visitor context

getRetentionPolicy

@NonNull
protected @NonNull RetentionPolicy getRetentionPolicy(@NonNull
 @NonNull Element annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Gets the retention policy for the given annotation.

Specified by:

getRetentionPolicy in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotation - The annotation

Returns:

The retention policy

getTypeForAnnotation

protected Element getTypeForAnnotation(AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the type of the given annotation.

Specified by:

getTypeForAnnotation in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The type

getAnnotationsForType

protected List<? extends AnnotationMirror> getAnnotationsForType(Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

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.

Specified by:

getAnnotationsForType in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The type element

Returns:

The annotations

isExcludedAnnotation

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

Description copied from class: AbstractAnnotationMetadataBuilder

Is the given annotation excluded for the specified element.

Overrides:

isExcludedAnnotation in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The element

annotationName - The annotation name

Returns:

True if it is excluded

buildHierarchy

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

Description copied from class: AbstractAnnotationMetadataBuilder

Build the type hierarchy for the given element.

Specified by:

buildHierarchy in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The element

inheritTypeAnnotations - Whether to inherit type annotations

declaredOnly - Whether to only include declared annotations

Returns:

The type hierarchy

readAnnotationRawValues

protected Map<? extends Element,?> readAnnotationRawValues(AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw annotation values from the given annotation.

Specified by:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The values

getAnnotationMember

@Nullable
protected @Nullable Element getAnnotationMember(Element annotationElement,
 CharSequence member)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the annotation member.

Specified by:

getAnnotationMember in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationElement - The annotation element

member - The member

Returns:

The annotation member element

getOriginatingClassName

protected String getOriginatingClassName(@NonNull
 @NonNull Element orginatingElement)

Specified by:

getOriginatingClassName in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

getAnnotationValues

protected <K extends Annotation>
Optional<AnnotationValue<K>> getAnnotationValues(Element originatingElement,
 Element member,
 Class<K> annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getAnnotationValues in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Type Parameters:

K - The annotation type

Parameters:

originatingElement - The originating element

member - The member

annotationType - The type

Returns:

The values

readAnnotationRawValues

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

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

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

readAnnotationRawValues

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

Description copied from class: AbstractAnnotationMetadataBuilder

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

Overrides:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

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

resolvedDefaults - The resolved defaults

isValidationRequired

protected boolean isValidationRequired(Element member)

Description copied from class: AbstractAnnotationMetadataBuilder

Return whether the given member requires validation.

Specified by:

isValidationRequired in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

member - The member

Returns:

True if it is

readAnnotationValue

protected Object readAnnotationValue(Element originatingElement,
 Element member,
 String annotationName,
 String memberName,
 Object annotationValue)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

readAnnotationValue in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

originatingElement - The originating element

member - The member

annotationName - The annotation name

memberName - The member name

annotationValue - The value

Returns:

The object

readAnnotationDefaultValues

protected Map<? extends Element,?> readAnnotationDefaultValues(String annotationTypeName,
 Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationTypeName - annotation name

element - the type

Returns:

The values

getAnnotationTypeName

protected String getAnnotationTypeName(AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the given type of the annotation.

Specified by:

getAnnotationTypeName in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The type

getElementName

protected String getElementName(Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the name for the given element.

Specified by:

getElementName in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The element

Returns:

The name

hasAnnotation

public boolean hasAnnotation(Element element,
 Class<? extends Annotation> ann)

Checks if a method has an annotation.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The method

ann - The annotation to look for

Returns:

Whether if the method has the annotation

hasAnnotation

public boolean hasAnnotation(Element element,
 String ann)

Checks if a method has an annotation.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The method

ann - The annotation to look for

Returns:

Whether if the method has the annotation

hasAnnotations

protected boolean hasAnnotations(Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether any annotations are present on the given element.

Specified by:

hasAnnotations in class AbstractAnnotationMetadataBuilder<Element,AnnotationMirror>

Parameters:

element - The element

Returns:

True if the annotation is present

clearCaches

public static void clearCaches()

Clears any caches from the last compilation round.

hasAnnotation

public static boolean hasAnnotation(ExecutableElement method,
 Class<? extends Annotation> ann)

Checks if a method has an annotation.

Parameters:

method - The method

ann - The annotation to look for

Returns:

Whether if the method has the annotation