Class PythonPropertyElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.visitor.PythonPropertyElement

All Implemented Interfaces:

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

public final class PythonPropertyElement
extends AbstractAnnotationElement
implements PropertyElement, ElementProvider

A property element representing a Python property (either a @property decorated method or a regular attribute).

This class implements the PropertyElement interface to provide property support for Python classes. Properties can be created from:

• @property decorated methods with optional @property.setter decorators
• Regular Python attributes (fields)

Since:

5.2.0

Author:

Micronaut Team

Nested Class Summary

Nested classes/interfaces inherited from interface PropertyElement

PropertyElement.AccessKind

Field Summary

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 Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface MutableAnnotationMetadataDelegate

EMPTY

Constructor Summary

Constructors

Constructor	Description
PythonPropertyElement(PropertyDef propertyDef, PythonProcessingEnvironment environment, ClassElement declaringType, ClassElement owningType, ElementAnnotationMetadataFactory metadataFactory)

Method Summary

Modifier and Type	Method	Description
protected io.micronaut.python.processing.visitor.AbstractPythonElement	copyThis()
protected void	copyValues(io.micronaut.python.processing.visitor.AbstractPythonElement element)
Element	element()
boolean	equals(Object o)
AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
ClassElement	getDeclaringType()
Optional<String>	getDocumentation(boolean parseContent)
ElementAnnotationMetadata	getElementAnnotationMetadata()
ClassElement	getGenericType()	Returns the generic type of the element.
String	getName()
PropertyDef	getNativeType()	Returns the native underlying type.
ClassElement	getOwningType()	The owning type is the type that owns this element.
PropertyElement.AccessKind	getReadAccessKind()
Optional<? extends MemberElement>	getReadMember()
Optional<MethodElement>	getReadMethod()
Optional<ClassElement>	getReadType()
Optional<AnnotationMetadata>	getReadTypeAnnotationMetadata()
ClassElement	getType()
PropertyElement.AccessKind	getWriteAccessKind()
Optional<? extends MemberElement>	getWriteMember()
Optional<MethodElement>	getWriteMethod()
Optional<ClassElement>	getWriteType()
Optional<AnnotationMetadata>	getWriteTypeAnnotationMetadata()
int	hashCode()
boolean	isProtected()
boolean	isPublic()
boolean	isReadOnly()	Return true only if the property has a getter but no setter.
boolean	isWriteOnly()	Return true only if the property doesn't support modifying the value.
protected final io.micronaut.python.processing.visitor.AbstractPythonElement	makeCopy()
boolean	overrides(PropertyElement overridden)	Does this property override the given property.
PropertyElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.

Methods inherited from class AbstractAnnotationElement

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

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, 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 Element

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

Methods inherited from interface MemberElement

getModifiers, hides, isAccessible, isAccessible, isAccessible, isReflectionRequired, isReflectionRequired

Methods inherited from interface PropertyElement

getField, isExcluded

Methods inherited from interface TypedElement

getArrayDimensions, isArray, isPrimitive, isVoid

Constructor Details

PythonPropertyElement

public PythonPropertyElement(PropertyDef propertyDef,
 PythonProcessingEnvironment environment,
 ClassElement declaringType,
 ClassElement owningType,
 ElementAnnotationMetadataFactory metadataFactory)

Method Details

equals

public boolean equals(Object o)

hashCode

public int hashCode()

getElementAnnotationMetadata

public ElementAnnotationMetadata getElementAnnotationMetadata()

Overrides:

getElementAnnotationMetadata in class AbstractAnnotationElement

Returns:

The element's annotation metadata

getAnnotationMetadataToWrite

public 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 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

getNativeType

public PropertyDef 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

getType

public ClassElement getType()

Specified by:

getType in interface PropertyElement

Specified by:

getType in interface TypedElement

Returns:

The type of the property

getGenericType

public ClassElement getGenericType()

Description copied from interface: TypedElement

Returns the generic type of the element. This differs from TypedElement.getType() as it returns the actual type without erasure. Whilst TypedElement.getType() is often needed to produce the correct byte code when generating code via ASM, the getGenericType() method is more useful for documentation and other types of code generation.

Specified by:

getGenericType in interface TypedElement

Returns:

The generic type

getReadMethod

public Optional<MethodElement> getReadMethod()

Specified by:

getReadMethod in interface PropertyElement

Returns:

The method to read the property

getWriteMethod

public Optional<MethodElement> getWriteMethod()

Specified by:

getWriteMethod in interface PropertyElement

Returns:

The method to write the property

getReadAccessKind

public PropertyElement.AccessKind getReadAccessKind()

Specified by:

getReadAccessKind in interface PropertyElement

Returns:

The read access kind of the property

getWriteAccessKind

public PropertyElement.AccessKind getWriteAccessKind()

Specified by:

getWriteAccessKind in interface PropertyElement

Returns:

The write access kind of the property

getDeclaringType

public ClassElement getDeclaringType()

Specified by:

getDeclaringType in interface MemberElement

Returns:

The declaring type of the element.

getOwningType

public ClassElement getOwningType()

Description copied from interface: MemberElement

The owning type is the type that owns this element. This can differ from MemberElement.getDeclaringType() in the case of inheritance since this method will return the subclass that owners the inherited member, whilst MemberElement.getDeclaringType() will return the super class that declares the type.

Specified by:

getOwningType in interface MemberElement

Returns:

The owning type.

element

@Nullable
public Element element()

Specified by:

element in interface ElementProvider

Returns:

The native element.

isReadOnly

public boolean isReadOnly()

Description copied from interface: PropertyElement

Return true only if the property has a getter but no setter.

Specified by:

isReadOnly in interface PropertyElement

Returns:

True if the property is read only.

isWriteOnly

public boolean isWriteOnly()

Description copied from interface: PropertyElement

Return true only if the property doesn't support modifying the value.

Specified by:

isWriteOnly in interface PropertyElement

Returns:

True if the property is writing only.

getReadMember

public Optional<? extends MemberElement> getReadMember()

Specified by:

getReadMember in interface PropertyElement

Returns:

The member to read the property

getWriteMember

public Optional<? extends MemberElement> getWriteMember()

Specified by:

getWriteMember in interface PropertyElement

Returns:

The member to write the property

getReadType

public Optional<ClassElement> getReadType()

Specified by:

getReadType in interface PropertyElement

Returns:

The read type.

getWriteType

public Optional<ClassElement> getWriteType()

Specified by:

getWriteType in interface PropertyElement

Returns:

The write type.

getReadTypeAnnotationMetadata

public Optional<AnnotationMetadata> getReadTypeAnnotationMetadata()

Specified by:

getReadTypeAnnotationMetadata in interface PropertyElement

Returns:

The read type annotation metadata.

getWriteTypeAnnotationMetadata

public Optional<AnnotationMetadata> getWriteTypeAnnotationMetadata()

Specified by:

getWriteTypeAnnotationMetadata in interface PropertyElement

Returns:

The write type annotation metadata.

overrides

public boolean overrides(PropertyElement overridden)

Description copied from interface: PropertyElement

Does this property override the given property. Supported only with languages that have native properties.

Specified by:

overrides in interface PropertyElement

Parameters:

overridden - The overridden method.

Returns:

True this property overrides the given property.

getDocumentation

public Optional<String> getDocumentation(boolean parseContent)

Specified by:

getDocumentation in interface Element

Specified by:

getDocumentation in interface PropertyElement

Parameters:

parseContent - True if the content should be parsed to extract documentation

Returns:

The documentation, if any.

copyThis

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

Returns:

copy of this element

withAnnotationMetadata

public PropertyElement withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Specified by:

withAnnotationMetadata in interface Element

Specified by:

withAnnotationMetadata in interface MemberElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new 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.