Class PythonEnumElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.visitor.AbstractPythonClassElement

io.micronaut.python.processing.visitor.PythonEnumElement

All Implemented Interfaces:

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

public final class PythonEnumElement
extends AbstractPythonClassElement
implements EnumElement

Represents a Python enum class element in the Micronaut injection context.

This class extends AbstractPythonClassElement and implements EnumElement to provide enum-specific functionality for Python enums parsed from AST.

Since:

5.2.0

Author:

Micronaut Team

Field Summary

Fields inherited from class AbstractPythonClassElement

arrayDimensions, environment, PYTHON_DEFAULT_PACKAGE, 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
PythonEnumElement(ClassDef classDef, PythonProcessingEnvironment environment)	Creates a new PythonEnumElement for the given class definition.
PythonEnumElement(ClassDef classDef, PythonProcessingEnvironment environment, int arrayDimensions)	Creates a new PythonEnumElement for the given class definition with array dimensions.

Method Summary

Modifier and Type	Method	Description
protected io.micronaut.python.processing.visitor.AbstractPythonElement	copyThis()
protected ClassElement	createWithArrayDimensions(int arrayDimensions)
List<EnumConstantElement>	elements()	The enum constant elements that make up this enum.
boolean	equals(Object o)
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.
String	getName()
int	hashCode()
boolean	isAssignable(String type)	Tests whether one type is assignable to another.
boolean	isEnum()	Whether this element is an enum.
boolean	isProtected()
boolean	isPublic()
protected final io.micronaut.python.processing.visitor.AbstractPythonElement	makeCopy()
String	toString()
List<String>	values()	The values that make up this enum.

Methods inherited from class AbstractPythonClassElement

copyValues, element, excludeIntrospectedProperties, findPythonClass, getAnnotationMetadata, getAnnotationMetadataToWrite, getArrayDimensions, getDocumentation, getEnclosedElements, getFields, getInterfaces, getNativeType, getPackageName, getSyntheticBeanProperties, getTypeAnnotationMetadata, getTypeAnnotationsKey, isAbstract, isArray, withAnnotationMetadata, withArrayDimensions

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 AnnotationMetadataProvider

getAnnotationMetadata

Methods inherited from interface ArrayableClassElement

fromArray, toArray

Methods inherited from interface ClassElement

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

Methods inherited from interface Element

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

Methods inherited from interface TypedElement

getArrayDimensions, getGenericType, isArray, isPrimitive, isVoid

Constructor Details

PythonEnumElement

public PythonEnumElement(ClassDef classDef,
 PythonProcessingEnvironment environment)

Creates a new PythonEnumElement for the given class definition.

Parameters:

classDef - The class definition from Python AST

environment - The Python processing environment

PythonEnumElement

public PythonEnumElement(ClassDef classDef,
 PythonProcessingEnvironment environment,
 int arrayDimensions)

Creates a new PythonEnumElement for the given class definition with array dimensions.

Parameters:

classDef - The class definition from Python AST

environment - The Python processing environment

arrayDimensions - The number of array dimensions

Method Details

isEnum

public boolean isEnum()

Description copied from interface: ClassElement

Whether this element is an enum.

Specified by:

isEnum in interface ClassElement

Returns:

True if it is an enum

createWithArrayDimensions

protected ClassElement createWithArrayDimensions(int arrayDimensions)

Specified by:

createWithArrayDimensions in class AbstractPythonClassElement

toString

public String toString()

Overrides:

toString in class Object

values

public List<String> values()

Description copied from interface: EnumElement

The values that make up this enum.

Specified by:

values in interface EnumElement

Returns:

The values

elements

public List<EnumConstantElement> elements()

Description copied from interface: EnumElement

The enum constant elements that make up this enum.

Specified by:

elements in interface EnumElement

Returns:

The enum constant elements

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

Overrides:

getBeanProperties in class AbstractPythonClassElement

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

Overrides:

getBeanProperties in class AbstractPythonClassElement

Parameters:

propertyElementQuery - The configuration

Returns:

The bean properties for this class element

copyThis

protected io.micronaut.python.processing.visitor.AbstractPythonElement copyThis()

Specified by:

copyThis in class AbstractPythonClassElement

Returns:

copy of this element

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

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