Class PythonAnnotationMetadataBuilder

java.lang.Object

io.micronaut.inject.annotation.AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

io.micronaut.python.processing.annotation.PythonAnnotationMetadataBuilder

public final class PythonAnnotationMetadataBuilder
extends AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Builder for creating annotation metadata from Python decorators and elements. This class extends Micronaut's annotation metadata builder to handle Python-specific annotation processing, converting Python decorators to Java annotation metadata.

Since:

5.2.0

Author:

Micronaut Team

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAnnotationMetadataBuilder

AbstractAnnotationMetadataBuilder.CachedAnnotationMetadata

Field Summary

Fields inherited from class AbstractAnnotationMetadataBuilder

ELEMENT_VALIDATOR

Constructor Summary

Constructors

Constructor	Description
PythonAnnotationMetadataBuilder(Map<String, DecoratorDef> decorators, PythonVisitorContext visitorContext)

Method Summary

Modifier and Type	Method	Description
protected void	addError(ElementDef originatingElement, String error)	Adds an error.
protected void	addWarning(ElementDef originatingElement, String warning)	Adds a warning.
AnnotationMetadata	buildDeclared(ElementDef element)	Build only metadata for declared annotations.
protected List<ElementDef>	buildHierarchy(ElementDef element, boolean inheritTypeAnnotations, boolean declaredOnly)	Build the type hierarchy for the given element.
protected ElementDef	getAnnotationMember(ElementDef annotationElement, CharSequence member)	Get the annotation member.
protected String	getAnnotationMemberName(ElementDef member)	Read the name of an annotation member.
protected Optional<ElementDef>	getAnnotationMirror(String annotationName)	Return a mirror for the given annotation.
protected List<? extends DecoratorDef>	getAnnotationsForType(ElementDef element)	Obtain the annotations for the given type.
protected String	getAnnotationTypeName(DecoratorDef annotationMirror)	Get the given type of the annotation.
protected <K extends Annotation> Optional<AnnotationValue<K>>	getAnnotationValues(ElementDef originatingElement, ElementDef member, Class<K> annotationType)	Resolve the annotations values from the given member for the given type.
protected String	getElementName(ElementDef element)	Get the name for the given element.
protected String	getOriginatingClassName(ElementDef originating)
protected String	getRepeatableContainerNameForType(ElementDef annotationType)	Obtain the name of the repeatable annotation if the annotation is one.
protected String	getRepeatableName(DecoratorDef annotationMirror)	Obtain the name of the repeatable annotation if the annotation is one.
protected RetentionPolicy	getRetentionPolicy(ElementDef annotation)	Gets the retention policy for the given annotation.
protected ElementDef	getTypeForAnnotation(DecoratorDef annotationMirror)	Get the type of the given annotation.
protected VisitorContext	getVisitorContext()	Returns the visitor context for this implementation.
protected boolean	hasAnnotation(ElementDef element, Class<? extends Annotation> annotation)	Checks whether an annotation is present.
protected boolean	hasAnnotation(ElementDef element, String annotation)	Checks whether an annotation is present.
protected boolean	hasAnnotations(ElementDef element)	Checks whether any annotations are present on the given element.
protected boolean	isValidationRequired(ElementDef member)	Return whether the given member requires validation.
List<AnnotationValue<?>>	mapAnnotation(DecoratorDef decorator)
protected void	postProcess(MutableAnnotationMetadata annotationMetadata, ElementDef element)
protected Map<? extends ElementDef, ?>	readAnnotationDefaultValues(String annotationName, ElementDef annotationType)	Read the raw default annotation values from the given annotation.
protected Map<? extends ElementDef, ?>	readAnnotationRawValues(DecoratorDef annotationMirror)	Read the raw annotation values from the given annotation.
protected void	readAnnotationRawValues(ElementDef originatingElement, String annotationName, ElementDef 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 Object	readAnnotationValue(ElementDef originatingElement, ElementDef 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 AbstractAnnotationMetadataBuilder

annotate, buildAnnotation, buildEvaluatedExpressionReference, buildInternal, clearCaches, clearMutated, clearMutated, copyToRuntime, findRepeatableContainerNameForType, getAnnotationDefaultValues, getAnnotationMappers, getAnnotationTransformers, getCachedAnnotationDefaults, getElementValidator, getMappedAnnotationNames, getMappedAnnotationPackages, getRetentionPolicy, isEvaluatedExpression, isExcludedAnnotation, isRepeatableAnnotationContainer, lookupOrBuild, lookupOrBuildForField, lookupOrBuildForMethod, lookupOrBuildForParameter, lookupOrBuildForType, readAnnotationDefaultValues, readAnnotationRawValues, readNestedAnnotationValue, readNestedAnnotationValue, removeAnnotation, removeAnnotationIf, removeStereotype, validateAnnotationValue

Methods inherited from class Object

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

Constructor Details

PythonAnnotationMetadataBuilder

public PythonAnnotationMetadataBuilder(Map<String, DecoratorDef> decorators,
 PythonVisitorContext visitorContext)

Method Details

mapAnnotation

public List<AnnotationValue<?>> mapAnnotation(DecoratorDef decorator)

buildDeclared

public AnnotationMetadata buildDeclared(ElementDef element)

Description copied from class: AbstractAnnotationMetadataBuilder

Build only metadata for declared annotations.

Overrides:

buildDeclared in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

Returns:

The AnnotationMetadata

getTypeForAnnotation

protected ElementDef getTypeForAnnotation(DecoratorDef annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the type of the given annotation.

Specified by:

getTypeForAnnotation in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationMirror - The annotation

Returns:

The type

getAnnotationTypeName

protected String getAnnotationTypeName(DecoratorDef annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the given type of the annotation.

Specified by:

getAnnotationTypeName in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationMirror - The annotation

Returns:

The type

buildHierarchy

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

Description copied from class: AbstractAnnotationMetadataBuilder

Build the type hierarchy for the given element.

Specified by:

buildHierarchy in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

inheritTypeAnnotations - Whether to inherit type annotations

declaredOnly - Whether to only include declared annotations

Returns:

The type hierarchy

getAnnotationsForType

protected List<? extends DecoratorDef> getAnnotationsForType(ElementDef 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<ElementDef, DecoratorDef>

Parameters:

element - The type element

Returns:

The annotations

hasAnnotation

protected boolean hasAnnotation(ElementDef element,
 String annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether an annotation is present.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

annotation - The annotation type name

Returns:

True if the annotation is present

hasAnnotation

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

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether an annotation is present.

Specified by:

hasAnnotation in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

annotation - The annotation type

Returns:

True if the annotation is present

hasAnnotations

protected boolean hasAnnotations(ElementDef element)

Description copied from class: AbstractAnnotationMetadataBuilder

Checks whether any annotations are present on the given element.

Specified by:

hasAnnotations in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

Returns:

True if the annotation is present

postProcess

protected void postProcess(MutableAnnotationMetadata annotationMetadata,
 ElementDef element)

Overrides:

postProcess in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

readAnnotationValue

protected Object readAnnotationValue(ElementDef originatingElement,
 ElementDef 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<ElementDef, DecoratorDef>

Parameters:

originatingElement - The originating element

member - The member

annotationName - The annotation name

memberName - The member name

annotationValue - The value

Returns:

The object

readAnnotationRawValues

protected void readAnnotationRawValues(ElementDef originatingElement,
 String annotationName,
 ElementDef 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<ElementDef, DecoratorDef>

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

isValidationRequired

protected boolean isValidationRequired(ElementDef member)

Description copied from class: AbstractAnnotationMetadataBuilder

Return whether the given member requires validation.

Specified by:

isValidationRequired in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

member - The member

Returns:

True if it is

addError

protected void addError(ElementDef originatingElement,
 String error)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds an error.

Specified by:

addError in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

originatingElement - The originating element

error - The error

addWarning

protected void addWarning(ElementDef originatingElement,
 String warning)

Description copied from class: AbstractAnnotationMetadataBuilder

Adds a warning.

Specified by:

addWarning in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

originatingElement - The originating element

warning - The warning

readAnnotationDefaultValues

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

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw default annotation values from the given annotation.

Specified by:

readAnnotationDefaultValues in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationName - annotation name

annotationType - the type

Returns:

The values

readAnnotationRawValues

protected Map<? extends ElementDef, ?> readAnnotationRawValues(DecoratorDef annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the raw annotation values from the given annotation.

Specified by:

readAnnotationRawValues in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationMirror - The annotation

Returns:

The values

getAnnotationValues

protected <K extends Annotation>
Optional<AnnotationValue<K>> getAnnotationValues(ElementDef originatingElement,
 ElementDef 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<ElementDef, DecoratorDef>

Type Parameters:

K - The annotation type

Parameters:

originatingElement - The originating element

member - The member

annotationType - The type

Returns:

The values

getElementName

protected String getElementName(ElementDef element)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the name for the given element.

Specified by:

getElementName in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

element - The element

Returns:

The name

getAnnotationMemberName

protected String getAnnotationMemberName(ElementDef member)

Description copied from class: AbstractAnnotationMetadataBuilder

Read the name of an annotation member.

Specified by:

getAnnotationMemberName in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

member - The member

Returns:

The name

getRepeatableName

protected String getRepeatableName(DecoratorDef annotationMirror)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableName in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationMirror - The annotation mirror

Returns:

Return the name or null

getRepeatableContainerNameForType

protected String getRepeatableContainerNameForType(ElementDef annotationType)

Description copied from class: AbstractAnnotationMetadataBuilder

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

Specified by:

getRepeatableContainerNameForType in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationType - The annotation mirror

Returns:

Return the name or null

getAnnotationMirror

protected Optional<ElementDef> getAnnotationMirror(String annotationName)

Description copied from class: AbstractAnnotationMetadataBuilder

Return a mirror for the given annotation.

Specified by:

getAnnotationMirror in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationName - The annotation name

Returns:

An optional mirror

getOriginatingClassName

protected String getOriginatingClassName(ElementDef originating)

Specified by:

getOriginatingClassName in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

getAnnotationMember

protected ElementDef getAnnotationMember(ElementDef annotationElement,
 CharSequence member)

Description copied from class: AbstractAnnotationMetadataBuilder

Get the annotation member.

Specified by:

getAnnotationMember in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotationElement - The annotation element

member - The member

Returns:

The annotation member element

getVisitorContext

protected VisitorContext getVisitorContext()

Description copied from class: AbstractAnnotationMetadataBuilder

Returns the visitor context for this implementation.

Specified by:

getVisitorContext in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Returns:

The visitor context

getRetentionPolicy

protected RetentionPolicy getRetentionPolicy(ElementDef annotation)

Description copied from class: AbstractAnnotationMetadataBuilder

Gets the retention policy for the given annotation.

Specified by:

getRetentionPolicy in class AbstractAnnotationMetadataBuilder<ElementDef, DecoratorDef>

Parameters:

annotation - The annotation

Returns:

The retention policy