io.micronaut.ast.groovy.annotation

Class GroovyAnnotationMetadataBuilder

java.lang.Object

io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

io.micronaut.ast.groovy.annotation.GroovyAnnotationMetadataBuilder

public class GroovyAnnotationMetadataBuilder
extends AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Groovy implementation of AbstractAnnotationMetadataBuilder.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static org.codehaus.groovy.ast.ClassNode	ANN_OVERRIDE
static String	VALIDATOR_KEY

Constructor Summary

Constructors

Constructor and Description
GroovyAnnotationMetadataBuilder(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.control.CompilationUnit compilationUnit)

Method Summary

Modifier and Type	Method and Description
protected void	addError(org.codehaus.groovy.ast.AnnotatedNode originatingElement, String error) Adds an error.
protected void	addWarning(org.codehaus.groovy.ast.AnnotatedNode originatingElement, String warning) Adds an warning.
protected List<org.codehaus.groovy.ast.AnnotatedNode>	buildHierarchy(org.codehaus.groovy.ast.AnnotatedNode element, boolean inheritTypeAnnotations, boolean declaredOnly) Build the type hierarchy for the given element.
protected VisitorContext	createVisitorContext() Creates the visitor context for this implementation.
protected org.codehaus.groovy.ast.AnnotatedNode	getAnnotationMember(org.codehaus.groovy.ast.AnnotatedNode originatingElement, CharSequence member) Get the annotation member.
protected String	getAnnotationMemberName(org.codehaus.groovy.ast.AnnotatedNode member) Read the name of an annotation member.
protected Map<String,? extends org.codehaus.groovy.ast.AnnotatedNode>	getAnnotationMembers(String annotationType) Gets the annotation members for the given type.
protected Optional<org.codehaus.groovy.ast.AnnotatedNode>	getAnnotationMirror(String annotationName) Return a mirror for the given annotation.
protected List<? extends org.codehaus.groovy.ast.AnnotationNode>	getAnnotationsForType(org.codehaus.groovy.ast.AnnotatedNode element) Obtain the annotations for the given type.
protected String	getAnnotationTypeName(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Get the given type of the annotation.
protected OptionalValues<?>	getAnnotationValues(org.codehaus.groovy.ast.AnnotatedNode originatingElement, org.codehaus.groovy.ast.AnnotatedNode member, Class<?> annotationType) Resolve the annotations values from the given member for the given type.
protected String	getDeclaringType(org.codehaus.groovy.ast.AnnotatedNode element) Obtains the declaring type for an element.
protected String	getElementName(org.codehaus.groovy.ast.AnnotatedNode element) Get the name for the given element.
protected AnnotatedElementValidator	getElementValidator() Obtains the element validator.
protected String	getRepeatableName(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Obtain the name of the repeatable annotation if the annotation is is one.
protected String	getRepeatableNameForType(org.codehaus.groovy.ast.AnnotatedNode annotationType) Obtain the name of the repeatable annotation if the annotation is is one.
protected RetentionPolicy	getRetentionPolicy(org.codehaus.groovy.ast.AnnotatedNode annotation) Gets the retention policy for the given annotation.
protected org.codehaus.groovy.ast.AnnotatedNode	getTypeForAnnotation(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Get the type of the given annotation.
protected boolean	hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode element, Class<? extends Annotation> annotation) Checks whether an annotation is present.
protected boolean	hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode element, String annotation) Checks whether an annotation is present.
protected boolean	hasAnnotations(org.codehaus.groovy.ast.AnnotatedNode element) Checks whether any annotations are present on the given element.
protected boolean	hasSimpleAnnotation(org.codehaus.groovy.ast.AnnotatedNode element, String simpleName) Returns true if a simple meta annotation is present for the given element and annotation type.
protected boolean	isExcludedAnnotation(org.codehaus.groovy.ast.AnnotatedNode element, String annotationName) Is the given annotation excluded for the specified element.
protected boolean	isInheritedAnnotation(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Test whether the annotation mirror is inherited.
protected boolean	isInheritedAnnotationType(org.codehaus.groovy.ast.AnnotatedNode annotationType) Test whether the annotation mirror is inherited.
protected boolean	isMethodOrClassElement(org.codehaus.groovy.ast.AnnotatedNode element) Whether the element is a field, method, class or constructor.
protected boolean	isValidationRequired(org.codehaus.groovy.ast.AnnotatedNode member) Return whether the given member requires validation.
protected Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?>	readAnnotationDefaultValues(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Read the raw default annotation values from the given annotation.
protected Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?>	readAnnotationDefaultValues(String annotationName, org.codehaus.groovy.ast.AnnotatedNode annotationType) Read the raw default annotation values from the given annotation.
protected void	readAnnotationRawValues(org.codehaus.groovy.ast.AnnotatedNode originatingElement, String annotationName, org.codehaus.groovy.ast.AnnotatedNode 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 Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?>	readAnnotationRawValues(org.codehaus.groovy.ast.AnnotationNode annotationMirror) Read the raw annotation values from the given annotation.
protected Object	readAnnotationValue(org.codehaus.groovy.ast.AnnotatedNode originatingElement, org.codehaus.groovy.ast.AnnotatedNode member, 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

addMutatedMetadata, annotate, build, build, buildDeclared, buildDeclared, buildForMethod, buildForParent, buildForParent, buildForParent, buildForParents, buildForParents, buildOverridden, clearCaches, clearMutated, copyToRuntime, getAnnotationMappers, getAnnotationTransformers, getMappedAnnotationNames, getMappedAnnotationPackages, isAnnotationMapped, isMetadataMutated, populateAnnotationData, populateAnnotationData, readNestedAnnotationValue, removeAnnotation, removeAnnotationIf, removeStereotype, validateAnnotationValue

Methods inherited from class java.lang.Object

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

Field Detail

ANN_OVERRIDE

public static final org.codehaus.groovy.ast.ClassNode ANN_OVERRIDE

VALIDATOR_KEY

public static final String VALIDATOR_KEY

See Also:

Constant Field Values

Constructor Detail

GroovyAnnotationMetadataBuilder

public GroovyAnnotationMetadataBuilder(org.codehaus.groovy.control.SourceUnit sourceUnit,
                                       org.codehaus.groovy.control.CompilationUnit compilationUnit)

Method Detail

isValidationRequired

protected boolean isValidationRequired(org.codehaus.groovy.ast.AnnotatedNode member)

Description copied from class: AbstractAnnotationMetadataBuilder

Return whether the given member requires validation.

Specified by:

isValidationRequired in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

member - The member

Returns:

True if it is

isExcludedAnnotation

protected boolean isExcludedAnnotation(@NonNull
                                       org.codehaus.groovy.ast.AnnotatedNode element,
                                       @NonNull
                                       String annotationName)

Description copied from class: AbstractAnnotationMetadataBuilder

Is the given annotation excluded for the specified element.

Overrides:

isExcludedAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

annotationName - The annotation name

Returns:

True if it is excluded

getAnnotationMember

protected org.codehaus.groovy.ast.AnnotatedNode getAnnotationMember(org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                                                                    CharSequence member)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the annotation member.

Specified by:

getAnnotationMember in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

originatingElement - The originatig element

member - The member

Returns:

The annotation member

getRetentionPolicy

protected RetentionPolicy getRetentionPolicy(@NonNull
                                             org.codehaus.groovy.ast.AnnotatedNode annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Gets the retention policy for the given annotation.

Specified by:

getRetentionPolicy in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotation - The annotation

Returns:

The retention policy

getElementValidator

protected AnnotatedElementValidator getElementValidator()

Description copied from class: AbstractAnnotationMetadataBuilder

Obtains the element validator.

Overrides:

getElementValidator in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Returns:

The validator.

addError

protected void addError(@NonNull
                        org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                        @NonNull
                        String error)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds an error.

Specified by:

addError in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

originatingElement - The originating element

error - The error

addWarning

protected void addWarning(@NonNull
                          org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                          @NonNull
                          String warning)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds an warning.

Specified by:

addWarning in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

originatingElement - The originating element

warning - The warning

isMethodOrClassElement

protected boolean isMethodOrClassElement(org.codehaus.groovy.ast.AnnotatedNode element)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

isMethodOrClassElement in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

Returns:

True if it is

getDeclaringType

protected String getDeclaringType(@NonNull
                                  org.codehaus.groovy.ast.AnnotatedNode element)

Description copied from class: AbstractAnnotationMetadataBuilder

Obtains the declaring type for an element.

Specified by:

getDeclaringType in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

Returns:

The declaring type

hasAnnotation

protected boolean hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode element,
                                Class<? extends Annotation> annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether an annotation is present.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

annotation - The annotation type

Returns:

True if the annotation is present

hasAnnotation

protected boolean hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode element,
                                String annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether an annotation is present.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

annotation - The annotation type name

Returns:

True if the annotation is present

hasAnnotations

protected boolean hasAnnotations(org.codehaus.groovy.ast.AnnotatedNode element)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether any annotations are present on the given element.

Specified by:

hasAnnotations in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

Returns:

True if the annotation is present

createVisitorContext

protected VisitorContext createVisitorContext()

Description copied from class: AbstractAnnotationMetadataBuilder

Creates the visitor context for this implementation.

Specified by:

createVisitorContext in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Returns:

The visitor context

getTypeForAnnotation

protected org.codehaus.groovy.ast.AnnotatedNode getTypeForAnnotation(org.codehaus.groovy.ast.AnnotationNode annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the type of the given annotation.

Specified by:

getTypeForAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The annotation

Returns:

The type

getRepeatableName

protected String getRepeatableName(org.codehaus.groovy.ast.AnnotationNode 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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The annotation mirror

Returns:

Return the name or null

getRepeatableNameForType

protected String getRepeatableNameForType(org.codehaus.groovy.ast.AnnotatedNode 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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationType - The annotation mirror

Returns:

Return the name or null

getAnnotationMirror

protected Optional<org.codehaus.groovy.ast.AnnotatedNode> getAnnotationMirror(String annotationName)

Description copied from class: AbstractAnnotationMetadataBuilder

Return a mirror for the given annotation.

Specified by:

getAnnotationMirror in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationName - The annotation name

Returns:

An optional mirror

getAnnotationTypeName

protected String getAnnotationTypeName(org.codehaus.groovy.ast.AnnotationNode annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the given type of the annotation.

Specified by:

getAnnotationTypeName in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The annotation

Returns:

The type

getElementName

protected String getElementName(org.codehaus.groovy.ast.AnnotatedNode element)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the name for the given element.

Specified by:

getElementName in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

Returns:

The name

getAnnotationsForType

protected List<? extends org.codehaus.groovy.ast.AnnotationNode> getAnnotationsForType(org.codehaus.groovy.ast.AnnotatedNode 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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The type element

Returns:

The annotations

buildHierarchy

protected List<org.codehaus.groovy.ast.AnnotatedNode> buildHierarchy(org.codehaus.groovy.ast.AnnotatedNode element,
                                                                     boolean inheritTypeAnnotations,
                                                                     boolean declaredOnly)

Description copied from class: AbstractAnnotationMetadataBuilder

Build the type hierarchy for the given element.

Specified by:

buildHierarchy in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

inheritTypeAnnotations - Whether to inherit type annotations

declaredOnly - Whether to only include declared annotations

Returns:

The type hierarchy

readAnnotationRawValues

protected void readAnnotationRawValues(org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                                       String annotationName,
                                       org.codehaus.groovy.ast.AnnotatedNode 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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

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

readAnnotationDefaultValues

protected Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?> readAnnotationDefaultValues(String annotationName,
                                                                                             org.codehaus.groovy.ast.AnnotatedNode annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationName - annotation name

annotationType - the type

Returns:

The values

isInheritedAnnotation

protected boolean isInheritedAnnotation(@NonNull
                                        org.codehaus.groovy.ast.AnnotationNode annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Test whether the annotation mirror is inherited.

Specified by:

isInheritedAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The mirror

Returns:

True if it is

isInheritedAnnotationType

protected boolean isInheritedAnnotationType(@NonNull
                                            org.codehaus.groovy.ast.AnnotatedNode annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

Test whether the annotation mirror is inherited.

Specified by:

isInheritedAnnotationType in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationType - The mirror

Returns:

True if it is

getAnnotationMembers

protected Map<String,? extends org.codehaus.groovy.ast.AnnotatedNode> getAnnotationMembers(String annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

Gets the annotation members for the given type.

Specified by:

getAnnotationMembers in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationType - The annotation type

Returns:

The members

hasSimpleAnnotation

protected boolean hasSimpleAnnotation(org.codehaus.groovy.ast.AnnotatedNode element,
                                      String simpleName)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

hasSimpleAnnotation in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

element - The element

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

Returns:

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

readAnnotationDefaultValues

protected Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?> readAnnotationDefaultValues(org.codehaus.groovy.ast.AnnotationNode annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The annotation

Returns:

The values

readAnnotationValue

protected Object readAnnotationValue(org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                                     org.codehaus.groovy.ast.AnnotatedNode member,
                                     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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

originatingElement - The originating element

member - The member

memberName - The member name

annotationValue - The value

Returns:

The object

readAnnotationRawValues

protected Map<? extends org.codehaus.groovy.ast.AnnotatedNode,?> readAnnotationRawValues(org.codehaus.groovy.ast.AnnotationNode annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw annotation values from the given annotation.

Specified by:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

annotationMirror - The annotation

Returns:

The values

getAnnotationValues

protected OptionalValues<?> getAnnotationValues(org.codehaus.groovy.ast.AnnotatedNode originatingElement,
                                                org.codehaus.groovy.ast.AnnotatedNode member,
                                                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<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

originatingElement - The originating element

member - The member

annotationType - The type

Returns:

The values

getAnnotationMemberName

protected String getAnnotationMemberName(org.codehaus.groovy.ast.AnnotatedNode member)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the name of an annotation member.

Specified by:

getAnnotationMemberName in class AbstractAnnotationMetadataBuilder<org.codehaus.groovy.ast.AnnotatedNode,org.codehaus.groovy.ast.AnnotationNode>

Parameters:

member - The member

Returns:

The name