Class PythonParameterElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.visitor.PythonParameterElement

All Implemented Interfaces:

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

public final class PythonParameterElement
extends AbstractAnnotationElement
implements ParameterElement

A parameter element representing a Python function parameter.

This class wraps parameter information from a Python function argument, providing type resolution and metadata for Micronaut's parameter processing.

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

Fields inherited from interface ParameterElement

ZERO_PARAMETER_ELEMENTS

Constructor Summary

Constructors

Constructor	Description
PythonParameterElement(ArgumentDef argumentDef, PythonProcessingEnvironment environment, PythonMethodElement methodElement, 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)
boolean	equals(Object o)
Optional<String>	getDocumentation(boolean parseContent)
ClassElement	getGenericType()	Returns the generic type of the element.
PythonMethodElement	getMethodElement()	Return method associated with this parameter.
String	getName()
ArgumentDef	getNativeType()	Returns the native underlying type.
ClassElement	getType()
int	hashCode()
boolean	isProtected()
boolean	isPublic()
protected final io.micronaut.python.processing.visitor.AbstractPythonElement	makeCopy()
ParameterElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.

Methods inherited from class AbstractAnnotationElement

annotate, annotate, annotate, annotate, annotate, getAnnotationMetadata, getAnnotationMetadataToWrite, getElementAnnotationMetadata, 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 AnnotationMetadataProvider

getAnnotationMetadata

Methods inherited from interface Element

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

Methods inherited from interface ParameterElement

getDescription

Methods inherited from interface TypedElement

getArrayDimensions, isArray, isPrimitive, isVoid

Constructor Details

PythonParameterElement

public PythonParameterElement(ArgumentDef argumentDef,
 PythonProcessingEnvironment environment,
 PythonMethodElement methodElement,
 ElementAnnotationMetadataFactory metadataFactory)

Method Details

getNativeType

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

Specified by:

getType in interface TypedElement

Returns:

The type of the parameter

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

getMethodElement

public PythonMethodElement getMethodElement()

Description copied from interface: ParameterElement

Return method associated with this parameter.

Specified by:

getMethodElement in interface ParameterElement

Returns:

The method element

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.

copyThis

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

Returns:

copy of this element

withAnnotationMetadata

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

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object