io.micronaut.annotation.processing

Class JavaAnnotationMetadataBuilder

java.lang.Object

io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

io.micronaut.annotation.processing.JavaAnnotationMetadataBuilder

public class JavaAnnotationMetadataBuilder
extends AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

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

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
JavaAnnotationMetadataBuilder(javax.lang.model.util.Elements elements, javax.annotation.processing.Messager messager, AnnotationUtils annotationUtils, ModelUtils modelUtils) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addError(javax.lang.model.element.Element originatingElement, java.lang.String error) Adds an error.
protected java.util.List<javax.lang.model.element.Element>	buildHierarchy(javax.lang.model.element.Element element, boolean inheritTypeAnnotations, boolean declaredOnly) Build the type hierarchy for the given element.
protected VisitorContext	createVisitorContext() Creates the visitor context for this implementation.
protected javax.lang.model.element.Element	getAnnotationMember(javax.lang.model.element.Element originatingElement, java.lang.CharSequence member) Get the annotation member.
protected java.lang.String	getAnnotationMemberName(javax.lang.model.element.Element member) Read the name of an annotation member.
protected java.util.Optional<javax.lang.model.element.Element>	getAnnotationMirror(java.lang.String annotationName) Return a mirror for the given annotation.
protected java.util.List<? extends javax.lang.model.element.AnnotationMirror>	getAnnotationsForType(javax.lang.model.element.Element element) Obtain the annotations for the given type.
protected java.lang.String	getAnnotationTypeName(javax.lang.model.element.AnnotationMirror annotationMirror) Get the given type of the annotation.
protected OptionalValues<?>	getAnnotationValues(javax.lang.model.element.Element originatingElement, javax.lang.model.element.Element member, java.lang.Class<?> annotationType) Resolve the annotations values from the given member for the given type.
protected java.lang.String	getDeclaringType(javax.lang.model.element.Element element) Obtains the declaring type for an element.
protected java.lang.String	getElementName(javax.lang.model.element.Element element) Get the name for the given element.
protected AnnotatedElementValidator	getElementValidator() Obtains the element validator.
protected java.lang.String	getRepeatableName(javax.lang.model.element.AnnotationMirror annotationMirror) Obtain the name of the repeatable annotation if the annotation is is one.
protected java.lang.String	getRepeatableNameForType(javax.lang.model.element.Element annotationType) Obtain the name of the repeatable annotation if the annotation is is one.
protected java.lang.annotation.RetentionPolicy	getRetentionPolicy(javax.lang.model.element.Element annotation) Gets the retention policy for the given annotation.
protected javax.lang.model.element.Element	getTypeForAnnotation(javax.lang.model.element.AnnotationMirror annotationMirror) Get the type of the given annotation.
boolean	hasAnnotation(javax.lang.model.element.Element element, java.lang.Class<? extends java.lang.annotation.Annotation> ann) Checks if a method has an annotation.
static boolean	hasAnnotation(javax.lang.model.element.ExecutableElement method, java.lang.Class<? extends java.lang.annotation.Annotation> ann) Checks if a method has an annotation.
protected boolean	isMethodOrClassElement(javax.lang.model.element.Element element) Whether the element is a field, method, class or constructor.
protected java.util.Map<? extends javax.lang.model.element.Element,?>	readAnnotationDefaultValues(javax.lang.model.element.AnnotationMirror annotationMirror) Read the raw default annotation values from the given annotation.
protected java.util.Map<? extends javax.lang.model.element.Element,?>	readAnnotationDefaultValues(java.lang.String annotationTypeName, javax.lang.model.element.Element element) Read the raw default annotation values from the given annotation.
protected java.util.Map<? extends javax.lang.model.element.Element,?>	readAnnotationRawValues(javax.lang.model.element.AnnotationMirror annotationMirror) Read the raw annotation values from the given annotation.
protected void	readAnnotationRawValues(javax.lang.model.element.Element originatingElement, java.lang.String annotationName, javax.lang.model.element.Element member, java.lang.String memberName, java.lang.Object annotationValue, java.util.Map<java.lang.CharSequence,java.lang.Object> annotationValues) Read the given member and value, applying conversions if necessary, and place the data in the given map.
protected java.lang.Object	readAnnotationValue(javax.lang.model.element.Element originatingElement, javax.lang.model.element.Element member, java.lang.String memberName, java.lang.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

addMutatedMetadata, annotate, build, build, buildDeclared, buildForMethod, buildForParent, buildForParent, buildForParent, buildOverridden, clearMutated, getAnnotationMappers, getMappedAnnotationNames, isAnnotationMapped, isMetadataMutated, populateAnnotationData, readNestedAnnotationValue, validateAnnotationValue

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaAnnotationMetadataBuilder

public JavaAnnotationMetadataBuilder(javax.lang.model.util.Elements elements,
                                     javax.annotation.processing.Messager messager,
                                     AnnotationUtils annotationUtils,
                                     ModelUtils modelUtils)

Default constructor.

Parameters:

elements - The elementUtils

messager - The messager

annotationUtils - The annotation utils

modelUtils - The model utils

Method Detail

getElementValidator

@Nullable
protected AnnotatedElementValidator getElementValidator()

Description copied from class: AbstractAnnotationMetadataBuilder

Obtains the element validator.

Overrides:

getElementValidator in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Returns:

The validator.

addError

protected void addError(@NonNull
                        javax.lang.model.element.Element originatingElement,
                        @NonNull
                        java.lang.String error)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds an error.

Specified by:

addError in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

originatingElement - The originating element

error - The error

getAnnotationMemberName

protected java.lang.String getAnnotationMemberName(javax.lang.model.element.Element member)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the name of an annotation member.

Specified by:

getAnnotationMemberName in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

member - The member

Returns:

The name

getRepeatableName

@Nullable
protected java.lang.String getRepeatableName(javax.lang.model.element.AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableName in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationMirror - The annotation mirror

Returns:

Return the name or null

getRepeatableNameForType

@Nullable
protected java.lang.String getRepeatableNameForType(javax.lang.model.element.Element annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableNameForType in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationType - The annotation mirror

Returns:

Return the name or null

getAnnotationMirror

protected java.util.Optional<javax.lang.model.element.Element> getAnnotationMirror(java.lang.String annotationName)

Description copied from class: AbstractAnnotationMetadataBuilder

Return a mirror for the given annotation.

Specified by:

getAnnotationMirror in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationName - The annotation name

Returns:

An optional mirror

createVisitorContext

protected VisitorContext createVisitorContext()

Description copied from class: AbstractAnnotationMetadataBuilder

Creates the visitor context for this implementation.

Specified by:

createVisitorContext in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Returns:

The visitor context

getRetentionPolicy

@NonNull
protected java.lang.annotation.RetentionPolicy getRetentionPolicy(@NonNull
                                                                           javax.lang.model.element.Element annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Gets the retention policy for the given annotation.

Specified by:

getRetentionPolicy in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotation - The annotation

Returns:

The retention policy

isMethodOrClassElement

protected boolean isMethodOrClassElement(javax.lang.model.element.Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

isMethodOrClassElement in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

element - The element

Returns:

True if it is

getDeclaringType

@NonNull
protected java.lang.String getDeclaringType(@NonNull
                                                     javax.lang.model.element.Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Obtains the declaring type for an element.

Specified by:

getDeclaringType in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

element - The element

Returns:

The declaring type

getTypeForAnnotation

protected javax.lang.model.element.Element getTypeForAnnotation(javax.lang.model.element.AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the type of the given annotation.

Specified by:

getTypeForAnnotation in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The type

getAnnotationsForType

protected java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationsForType(javax.lang.model.element.Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Obtain the annotations for the given type.

Specified by:

getAnnotationsForType in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

element - The type element

Returns:

The annotations

buildHierarchy

protected java.util.List<javax.lang.model.element.Element> buildHierarchy(javax.lang.model.element.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<javax.lang.model.element.Element,javax.lang.model.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 java.util.Map<? extends javax.lang.model.element.Element,?> readAnnotationRawValues(javax.lang.model.element.AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw annotation values from the given annotation.

Specified by:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The values

getAnnotationMember

@Nullable
protected javax.lang.model.element.Element getAnnotationMember(javax.lang.model.element.Element originatingElement,
                                                                         java.lang.CharSequence member)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the annotation member.

Specified by:

getAnnotationMember in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

originatingElement - The originatig element

member - The member

Returns:

The annotation member

getAnnotationValues

protected OptionalValues<?> getAnnotationValues(javax.lang.model.element.Element originatingElement,
                                                javax.lang.model.element.Element member,
                                                java.lang.Class<?> annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getAnnotationValues in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

originatingElement - The originating element

member - The member

annotationType - The type

Returns:

The values

readAnnotationRawValues

protected void readAnnotationRawValues(javax.lang.model.element.Element originatingElement,
                                       java.lang.String annotationName,
                                       javax.lang.model.element.Element member,
                                       java.lang.String memberName,
                                       java.lang.Object annotationValue,
                                       java.util.Map<java.lang.CharSequence,java.lang.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<javax.lang.model.element.Element,javax.lang.model.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

readAnnotationValue

protected java.lang.Object readAnnotationValue(javax.lang.model.element.Element originatingElement,
                                               javax.lang.model.element.Element member,
                                               java.lang.String memberName,
                                               java.lang.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<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

originatingElement - The originating element

member - The member

memberName - The member name

annotationValue - The value

Returns:

The object

readAnnotationDefaultValues

protected java.util.Map<? extends javax.lang.model.element.Element,?> readAnnotationDefaultValues(javax.lang.model.element.AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The values

readAnnotationDefaultValues

protected java.util.Map<? extends javax.lang.model.element.Element,?> readAnnotationDefaultValues(java.lang.String annotationTypeName,
                                                                                                  javax.lang.model.element.Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationTypeName - annotation name

element - the type

Returns:

The values

getAnnotationTypeName

protected java.lang.String getAnnotationTypeName(javax.lang.model.element.AnnotationMirror annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the given type of the annotation.

Specified by:

getAnnotationTypeName in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

annotationMirror - The annotation

Returns:

The type

getElementName

protected java.lang.String getElementName(javax.lang.model.element.Element element)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the name for the given element.

Specified by:

getElementName in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

element - The element

Returns:

The name

hasAnnotation

public boolean hasAnnotation(javax.lang.model.element.Element element,
                             java.lang.Class<? extends java.lang.annotation.Annotation> ann)

Checks if a method has an annotation.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<javax.lang.model.element.Element,javax.lang.model.element.AnnotationMirror>

Parameters:

element - The method

ann - The annotation to look for

Returns:

Whether if the method has the annotation

hasAnnotation

public static boolean hasAnnotation(javax.lang.model.element.ExecutableElement method,
                                    java.lang.Class<? extends java.lang.annotation.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