Class PythonScriptElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.visitor.PythonScriptElement

All Implemented Interfaces:

ElementProvider, AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, MutableAnnotationMetadataDelegate<Element>, ClassElement, Element, TypedElement

public final class PythonScriptElement
extends AbstractAnnotationElement
implements ClassElement, ElementProvider

Represents a Python script as a Micronaut ClassElement. Scripts are modeled as singleton classes where module-level attributes become injectable fields and module-level functions become methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected ElementDef	typeAnnotationsKey

Fields inherited from class AbstractAnnotationElement

elementAnnotationMetadataFactory, presetAnnotationMetadata

Fields inherited from interface AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface AnnotationSource

EMPTY

Fields inherited from interface ClassElement

ZERO_CLASS_ELEMENTS

Fields inherited from interface Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface MutableAnnotationMetadataDelegate

EMPTY

Constructor Summary

Constructors

Constructor	Description
PythonScriptElement(ScriptDef scriptDef, PythonProcessingEnvironment environment)

Method Summary

Modifier and Type	Method	Description
protected PythonScriptElement	copyThis()
protected void	copyValues(io.micronaut.python.processing.visitor.AbstractPythonElement element)
@Nullable Element	element()
boolean	equals(Object o)
@NonNull ClassElement	fromArray()	Dereference a class element denoting an array type by converting it to its element type.
@NonNull AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
protected MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
List<PropertyElement>	getBeanProperties()	Returns the bean properties (getters and setters) for this class element.
List<PropertyElement>	getBeanProperties(PropertyElementQuery propertyElementQuery)	Returns the bean properties (getters and setters) for this class element based on custom configuration.
<T extends Element> List<T>	getEnclosedElements(ElementQuery<T> query)	Return the elements that match the given query.
List<ClassElement>	getInterfaces()
String	getName()
ScriptDef	getNativeType()	Returns the native underlying type.
Optional<MethodElement>	getPrimaryConstructor()	Find and return a single primary constructor.
Optional<ClassElement>	getSuperType()	Returns the super type of this element or empty if the element has no super type.
List<PropertyElement>	getSyntheticBeanProperties()	Returns the synthetic bean properties.
@NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata>	getTypeAnnotationMetadata()	Returns the type annotations.
ElementDef	getTypeAnnotationsKey()
int	hashCode()
boolean	isAbstract()
boolean	isAssignable(String type)	Tests whether one type is assignable to another.
boolean	isProtected()
boolean	isPublic()
protected final io.micronaut.python.processing.visitor.AbstractPythonElement	makeCopy()
@NonNull ClassElement	toArray()	Convert the class element to an element for the same type, but representing an array.
String	toString()
ClassElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.

Methods inherited from class AbstractAnnotationElement

annotate, annotate, annotate, annotate, annotate, getElementAnnotationMetadata, getElementAnnotationMetadataFactory, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AnnotatedElement

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface AnnotationMetadata

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface AnnotationMetadataDelegate

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasEvaluatedExpressions, hasPropertyExpressions, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface ClassElement

addAssociatedBean, findDefaultStaticCreator, findField, findMethod, findStaticCreator, foldBoundGenericTypes, getAccessibleConstructors, getAccessibleStaticCreators, getAllTypeArguments, getBoundGenericTypes, getCanonicalName, getDeclaredGenericPlaceholders, getDefaultConstructor, getEnclosedElement, getEnclosingType, getFields, getFirstTypeArgument, getMethods, getOptionalValueType, getPackage, getPackageName, getPermittedSubclasses, getRawClassElement, getSimpleName, getType, getTypeArguments, getTypeArguments, getTypeArguments, hasUnresolvedTypes, isAssignable, isAssignable, isContainerType, isEnum, isGenericPlaceholder, isInner, isInterface, isIterable, isOptional, isProxy, isRawType, isRecord, isSealed, isTypeVariable, isWildcard, withBoundGenericTypes, withTypeArguments, withTypeArguments

Methods inherited from interface Element

annotate, annotate, annotate, annotate, annotate, getDescription, getDescription, getDocumentation, getDocumentation, getModifiers, getName, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

Methods inherited from interface TypedElement

getArrayDimensions, getGenericType, isArray, isPrimitive, isVoid

Field Details

typeAnnotationsKey

protected ElementDef typeAnnotationsKey

Constructor Details

PythonScriptElement

public PythonScriptElement(ScriptDef scriptDef,
 PythonProcessingEnvironment environment)

Method Details

getAnnotationMetadataToWrite

protected MutableAnnotationMetadataDelegate<?> getAnnotationMetadataToWrite()

Description copied from class: AbstractAnnotationElement

Get annotation metadata to add or remove annotations.

Overrides:

getAnnotationMetadataToWrite in class AbstractAnnotationElement

Returns:

The annotation metadata to write

getAnnotationMetadata

public @NonNull AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Overrides:

getAnnotationMetadata in class AbstractAnnotationElement

Returns:

The AnnotationMetadata

getTypeAnnotationMetadata

public @NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata> getTypeAnnotationMetadata()

Description copied from interface: ClassElement

Returns the type annotations. Added by: - The declaration of the type variable ElementType.TYPE_PARAMETER - The use of the type ElementType.TYPE

Specified by:

getTypeAnnotationMetadata in interface ClassElement

Returns:

the type annotations

getTypeAnnotationsKey

public ElementDef getTypeAnnotationsKey()

withAnnotationMetadata

public ClassElement withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Specified by:

withAnnotationMetadata in interface ClassElement

Specified by:

withAnnotationMetadata in interface Element

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

getNativeType

public ScriptDef getNativeType()

Description copied from interface: Element

Returns the native underlying type. This API is extended by all inject language implementations. The object returned by this method will be the language native type the information is being retrieved from.

Specified by:

getNativeType in interface Element

Returns:

The native type

copyThis

protected PythonScriptElement copyThis()

Returns:

copy of this element

toString

public String toString()

Overrides:

toString in class Object

isAssignable

public boolean isAssignable(String type)

Description copied from interface: ClassElement

Tests whether one type is assignable to another.

Specified by:

isAssignable in interface ClassElement

Parameters:

type - The type to check

Returns:

true if and only if this type is assignable to the second

getPrimaryConstructor

public Optional<MethodElement> getPrimaryConstructor()

Description copied from interface: ClassElement

Find and return a single primary constructor. If more than constructor candidate exists, then return empty unless a constructor is found that is annotated with either Creator or AnnotationUtil.INJECT.

Specified by:

getPrimaryConstructor in interface ClassElement

Returns:

The primary constructor if one is present

getSuperType

public Optional<ClassElement> getSuperType()

Description copied from interface: ClassElement

Returns the super type of this element or empty if the element has no super type.

Specified by:

getSuperType in interface ClassElement

Returns:

An optional of the super type

getInterfaces

public List<ClassElement> getInterfaces()

Specified by:

getInterfaces in interface ClassElement

Returns:

The interfaces implemented by this class element

toArray

public @NonNull ClassElement toArray()

Description copied from interface: ClassElement

Convert the class element to an element for the same type, but representing an array. Do not mutate the existing instance. Create a new instance instead.

Specified by:

toArray in interface ClassElement

Returns:

A new class element

fromArray

public @NonNull ClassElement fromArray()

Description copied from interface: ClassElement

Dereference a class element denoting an array type by converting it to its element type. Do not mutate the existing instance. Create a new instance instead.

Specified by:

fromArray in interface ClassElement

Returns:

A new class element

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface Element

Returns:

True if the element is abstract.

element

@Nullable
public @Nullable Element element()

Specified by:

element in interface ElementProvider

Returns:

The native element.

getEnclosedElements

public <T extends Element> List<T> getEnclosedElements(ElementQuery<T> query)

Description copied from interface: ClassElement

Return the elements that match the given query.

Specified by:

getEnclosedElements in interface ClassElement

Type Parameters:

T - The element type

Parameters:

query - The query to use.

Returns:

The fields

getSyntheticBeanProperties

public List<PropertyElement> getSyntheticBeanProperties()

Description copied from interface: ClassElement

Returns the synthetic bean properties. The properties where one of the methods (getter or setter) is synthetic - not user defined but created by the compiler.

Specified by:

getSyntheticBeanProperties in interface ClassElement

Returns:

The bean properties for this class element

getBeanProperties

public List<PropertyElement> getBeanProperties()

Description copied from interface: ClassElement

Returns the bean properties (getters and setters) for this class element.

Specified by:

getBeanProperties in interface ClassElement

Returns:

The bean properties for this class element

getBeanProperties

public List<PropertyElement> getBeanProperties(PropertyElementQuery propertyElementQuery)

Description copied from interface: ClassElement

Returns the bean properties (getters and setters) for this class element based on custom configuration.

Specified by:

getBeanProperties in interface ClassElement

Parameters:

propertyElementQuery - The configuration

Returns:

The bean properties for this class element

copyValues

protected void copyValues(io.micronaut.python.processing.visitor.AbstractPythonElement element)

Parameters:

element - the values to be copied to

makeCopy

protected final io.micronaut.python.processing.visitor.AbstractPythonElement makeCopy()

getName

public String getName()

Specified by:

getName in interface Element

Specified by:

getName in interface Named

Returns:

The name of the element. For a type this represents the binary name.

isProtected

public boolean isProtected()

Specified by:

isProtected in interface Element

Returns:

True if the element is protected.

isPublic

public boolean isPublic()

Specified by:

isPublic in interface Element

Returns:

True if the element is public.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object