Class PythonGenericPlaceholderElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.python.processing.element.AbstractPythonClassElement

io.micronaut.python.processing.element.PythonGenericPlaceholderElement

All Implemented Interfaces:

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

public final class PythonGenericPlaceholderElement
extends AbstractPythonClassElement
implements GenericPlaceholderElement

Implementation of GenericPlaceholderElement for Python TypeVars.

Since:

5.2.0

Author:

Micronaut

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
PythonGenericPlaceholderElement(TypeVar typeVar, PythonProcessingEnvironment environment, List<ClassElement> bounds)
PythonGenericPlaceholderElement(TypeVar typeVar, PythonProcessingEnvironment environment, List<ClassElement> bounds, Element declaringElement)

Method Summary

Modifier and Type	Method	Description
protected io.micronaut.python.processing.element.AbstractPythonElement	copyThis()
protected ClassElement	createWithArrayDimensions(int arrayDimensions)
boolean	equals(Object o)
@NonNull AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
protected MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
@NonNull List<? extends ClassElement>	getBounds()	Returns the bounds of this the generic placeholder empty.
Optional<Element>	getDeclaringElement()
@NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata>	getGenericTypeAnnotationMetadata()	Returns the type parameter annotations.
Set<ElementModifier>	getModifiers()	Python has no access modifiers, so the modifiers are derived from the visibility, static, abstract and final predicates of the element: an element is public unless its name marks it private, which keeps the modifier set consistent with Element.isPublic(), Element.isStatic(), Element.isAbstract() and Element.isFinal() for the callers that filter on modifiers, such as ElementQuery.modifiers(...) and BeanElementBuilder.produceBeans(...).
String	getName()
@NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata>	getTypeAnnotationMetadata()	Returns the type annotations.
@NonNull String	getVariableName()
int	hashCode()
boolean	isAssignable(String type)	Tests whether one type is assignable to another.
boolean	isProtected()
boolean	isPublic()
boolean	isRawType()	Is raw type.
boolean	isTypeVariable()	In this case of calling ClassElement.getTypeArguments() a returned ClassElement may represent a type variable in which case this method will return true.
protected final io.micronaut.python.processing.element.AbstractPythonElement	makeCopy()
String	toString()
PythonGenericPlaceholderElement	withTypeUseAnnotationMetadata(ElementAnnotationMetadata typeUseAnnotationMetadata)	The type variable used with type-use annotations, such as Annotated[E, NotNull()] as a type argument.

Methods inherited from class AbstractPythonClassElement

copyValues, element, excludeIntrospectedProperties, findPythonClass, getArrayDimensions, getBeanProperties, getBeanProperties, getDocumentation, getEnclosedElements, getFields, getInterfaces, getNativeType, getPackageName, getSyntheticBeanProperties, 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 ArrayableClassElement

fromArray, toArray

Methods inherited from interface ClassElement

addAssociatedBean, findDefaultStaticCreator, findField, findMethod, findStaticCreator, foldBoundGenericTypes, getAccessibleConstructors, getAccessibleStaticCreators, getAllTypeArguments, getBeanProperties, getBeanProperties, getBoundGenericTypes, getCanonicalName, getDeclaredGenericPlaceholders, getDefaultConstructor, getEnclosedElement, getEnclosedElements, getEnclosingType, getFields, getFirstTypeArgument, getInterfaces, getMethods, getOptionalValueType, getPackage, getPackageName, getPermittedSubclasses, getPrimaryConstructor, getRawClassElement, getSimpleName, getSuperType, getSyntheticBeanProperties, getType, getTypeArguments, getTypeArguments, getTypeArguments, hasUnresolvedTypes, isAssignable, isAssignable, isContainerType, isEnum, isGenericPlaceholder, isInner, isInterface, isIterable, isOptional, isProxy, isRecord, isSealed, 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 GenericElement

getGenericNativeType, resolved

Methods inherited from interface GenericPlaceholderElement

getRequiredDeclaringElement, getResolved

Methods inherited from interface TypedElement

getArrayDimensions, getGenericType, isArray, isPrimitive, isVoid

Constructor Details

PythonGenericPlaceholderElement

public PythonGenericPlaceholderElement(TypeVar typeVar,
 PythonProcessingEnvironment environment,
 List<ClassElement> bounds)

PythonGenericPlaceholderElement

public PythonGenericPlaceholderElement(TypeVar typeVar,
 PythonProcessingEnvironment environment,
 List<ClassElement> bounds,
 Element declaringElement)

Method Details

withTypeUseAnnotationMetadata

public PythonGenericPlaceholderElement withTypeUseAnnotationMetadata(ElementAnnotationMetadata typeUseAnnotationMetadata)

The type variable used with type-use annotations, such as Annotated[E, NotNull()] as a type argument. The copy stays a GenericPlaceholderElement, so the type argument keeps naming the type variable.

Parameters:

typeUseAnnotationMetadata - The type-use annotation metadata of the type node

Returns:

The annotated type variable

createWithArrayDimensions

protected ClassElement createWithArrayDimensions(int arrayDimensions)

Specified by:

createWithArrayDimensions in class AbstractPythonClassElement

copyThis

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

Specified by:

copyThis in class AbstractPythonClassElement

Returns:

copy of this element

getAnnotationMetadataToWrite

protected MutableAnnotationMetadataDelegate<?> getAnnotationMetadataToWrite()

Description copied from class: AbstractAnnotationElement

Get annotation metadata to add or remove annotations.

Overrides:

getAnnotationMetadataToWrite in class AbstractPythonClassElement

Returns:

The annotation metadata to write

getAnnotationMetadata

@NonNull
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 AbstractPythonClassElement

Returns:

The AnnotationMetadata

getTypeAnnotationMetadata

@NonNull
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

Overrides:

getTypeAnnotationMetadata in class AbstractPythonClassElement

Returns:

the type annotations

getGenericTypeAnnotationMetadata

@NonNull
public @NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata> getGenericTypeAnnotationMetadata()

Description copied from interface: GenericElement

Returns the type parameter annotations. Added to this generic element by: - The declaration of the type variable ElementType.TYPE_PARAMETER - The use of the type ElementType.TYPE

Specified by:

getGenericTypeAnnotationMetadata in interface GenericElement

Returns:

the type annotations

isTypeVariable

public boolean isTypeVariable()

Description copied from interface: ClassElement

In this case of calling ClassElement.getTypeArguments() a returned ClassElement may represent a type variable in which case this method will return true.

Specified by:

isTypeVariable in interface ClassElement

Returns:

Is this type a type variable.

isRawType

public boolean isRawType()

Description copied from interface: ClassElement

Is raw type.

Specified by:

isRawType in interface ClassElement

Returns:

true if the type is raw

getBounds

@NonNull
public @NonNull List<? extends ClassElement> getBounds()

Description copied from interface: GenericPlaceholderElement

Returns the bounds of this the generic placeholder empty. Always returns a non-empty list.

Specified by:

getBounds in interface GenericPlaceholderElement

Returns:

The bounds declared for this type variable.

getVariableName

@NonNull
public @NonNull String getVariableName()

Specified by:

getVariableName in interface GenericPlaceholderElement

Returns:

The name of the placeholder variable.

getDeclaringElement

public Optional<Element> getDeclaringElement()

Specified by:

getDeclaringElement in interface GenericPlaceholderElement

Returns:

The element declaring this variable, if it can be determined. Must be either a method or a class.

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

toString

public String toString()

Overrides:

toString in class Object

makeCopy

protected final io.micronaut.python.processing.element.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.

getModifiers

public Set<ElementModifier> getModifiers()

Python has no access modifiers, so the modifiers are derived from the visibility, static, abstract and final predicates of the element: an element is public unless its name marks it private, which keeps the modifier set consistent with Element.isPublic(), Element.isStatic(), Element.isAbstract() and Element.isFinal() for the callers that filter on modifiers, such as ElementQuery.modifiers(...) and BeanElementBuilder.produceBeans(...).

Specified by:

getModifiers in interface Element

Returns:

The modifiers

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object