Class PythonPropertyGetterMethodElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.visitor.PythonPropertyGetterMethodElement

All Implemented Interfaces:

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

public final class PythonPropertyGetterMethodElement
extends AbstractAnnotationElement
implements MethodElement, ElementProvider

A synthetic getter method element for Python properties. This allows synthetic property getters to support annotation mutation, unlike MethodElement.of() which creates immutable elements.

Since:

5.2.0

Author:

Micronaut Team

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
PythonPropertyGetterMethodElement(PythonPropertyElement propertyElement, 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.
protected MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
ClassElement	getDeclaringType()
Optional<String>	getDocumentation(boolean parseContent)
protected ElementAnnotationMetadata	getElementAnnotationMetadata()
ClassElement	getGenericReturnType()	The generic return type of the method.
@NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata>	getMethodAnnotationMetadata()	Returns the method annotations.
String	getName()
Object	getNativeType()	Returns the native underlying type.
ClassElement	getOwningType()	The owning type is the type that owns this element.
ParameterElement[]	getParameters()
ClassElement	getReturnType()
int	hashCode()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isReflectionRequired()	Returns whether this member element will require reflection to invoke or retrieve at runtime.
boolean	isReflectionRequired(ClassElement callingType)	Returns whether this member element will require reflection to invoke or retrieve at runtime.
boolean	isSynthetic()	Checks if the current element is synthetic - not user defined but created by the compiler.
protected final io.micronaut.python.processing.visitor.AbstractPythonElement	makeCopy()
MethodElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.
MethodElement	withParameters(ParameterElement... newParameters)	Takes this method element and transforms into a new method element with the given parameters.

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, getDocumentation, getSimpleName, isAbstract, isFinal, isPackagePrivate, isStatic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

Methods inherited from interface MemberElement

getModifiers, isAccessible, isAccessible, isAccessible

Methods inherited from interface MethodElement

addAssociatedBean, findParameterIndex, getDeclaredTypeArguments, getDeclaredTypeVariables, getDescription, getOverriddenMethods, getParameter, getReceiverType, getSuspendParameters, getThrownTypes, getTypeArguments, hasParameters, hides, hides, isDefault, isSubSignature, isSuspend, isVarArgs, overrides, withNewOwningType, withNewParameters

Constructor Details

PythonPropertyGetterMethodElement

public PythonPropertyGetterMethodElement(PythonPropertyElement propertyElement,
 PythonProcessingEnvironment environment,
 ClassElement declaringType,
 ClassElement owningType,
 ElementAnnotationMetadataFactory metadataFactory)

Method Details

getMethodAnnotationMetadata

public @NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata> getMethodAnnotationMetadata()

Description copied from interface: MethodElement

Returns the method annotations. The method will only return annotations defined on a method or inherited from the super methods, while AnnotationMetadataProvider.getAnnotationMetadata() for a method combines the class and the method annotations. NOTE: For a constructor AnnotationMetadataProvider.getAnnotationMetadata() will not combine the class annotations.

Specified by:

getMethodAnnotationMetadata in interface MethodElement

Returns:

The method annotation metadata

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

getElementAnnotationMetadata

protected ElementAnnotationMetadata getElementAnnotationMetadata()

Overrides:

getElementAnnotationMetadata in class AbstractAnnotationElement

Returns:

The element's annotation metadata

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

isReflectionRequired

public boolean isReflectionRequired()

Description copied from interface: MemberElement

Returns whether this member element will require reflection to invoke or retrieve at runtime.

This method uses MemberElement.getOwningType() as the calling type for this method.

Specified by:

isReflectionRequired in interface MemberElement

Returns:

Will return true if reflection is required.

isReflectionRequired

public boolean isReflectionRequired(ClassElement callingType)

Description copied from interface: MemberElement

Returns whether this member element will require reflection to invoke or retrieve at runtime.

Specified by:

isReflectionRequired in interface MemberElement

Parameters:

callingType - The calling type

Returns:

Will return true if reflection is required.

getNativeType

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

getReturnType

public ClassElement getReturnType()

Specified by:

getReturnType in interface MethodElement

Returns:

The return type of the method

getGenericReturnType

public ClassElement getGenericReturnType()

Description copied from interface: MethodElement

The generic return type of the method.

Specified by:

getGenericReturnType in interface MethodElement

Returns:

The return type of the method

getParameters

public ParameterElement[] getParameters()

Specified by:

getParameters in interface MethodElement

Returns:

The method parameters

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.

withParameters

public MethodElement withParameters(ParameterElement... newParameters)

Description copied from interface: MethodElement

Takes this method element and transforms into a new method element with the given parameters.

Specified by:

withParameters in interface MethodElement

Parameters:

newParameters - The new parameters

Returns:

A new method element

isPublic

public boolean isPublic()

Specified by:

isPublic in interface Element

Returns:

True if the element is public.

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface Element

Returns:

True if the element is private.

isProtected

public boolean isProtected()

Specified by:

isProtected in interface Element

Returns:

True if the element is protected.

isSynthetic

public boolean isSynthetic()

Description copied from interface: Element

Checks if the current element is synthetic - not user defined but created by the compiler.

Specified by:

isSynthetic in interface Element

Returns:

True if the element is synthetic.

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.

getDocumentation

public Optional<String> getDocumentation(boolean parseContent)

Specified by:

getDocumentation in interface Element

Parameters:

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

Returns:

The documentation, if any.

equals

public boolean equals(Object o)

hashCode

public int hashCode()

copyThis

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

Returns:

copy of this element

withAnnotationMetadata

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

Specified by:

withAnnotationMetadata in interface MethodElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

element

public Element element()

Specified by:

element in interface ElementProvider

Returns:

The native 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()