Package io.micronaut.annotation.processing.visitor

Class JavaClassElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.annotation.processing.visitor.AbstractJavaElement

io.micronaut.annotation.processing.visitor.JavaClassElement

All Implemented Interfaces:

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

@Internal
public class JavaClassElement
extends AbstractJavaElement
implements ArrayableClassElement

A class element returning data from a TypeElement.

Since:

1.0

Author:

James Kleeh, graemerocher, Denis Stepanov

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	arrayDimensions
protected final TypeElement	classElement

Fields inherited from class io.micronaut.annotation.processing.visitor.AbstractJavaElement

visitorContext

Fields inherited from class io.micronaut.inject.ast.annotation.AbstractAnnotationElement

elementAnnotationMetadataFactory, presetAnnotationMetadata

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Fields inherited from interface io.micronaut.inject.ast.ClassElement

ZERO_CLASS_ELEMENTS

Fields inherited from interface io.micronaut.inject.ast.Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface io.micronaut.inject.ast.annotation.MutableAnnotationMetadataDelegate

EMPTY

Constructor Summary

Constructors

Constructor	Description
JavaClassElement(JavaNativeElement.Class nativeType, ElementAnnotationMetadataFactory annotationMetadataFactory, JavaVisitorContext visitorContext)

Method Summary

Modifier and Type	Method	Description
protected JavaClassElement	copyThis()
@NonNull List<MethodElement>	getAccessibleStaticCreators()	Get accessible static creators.
@NonNull Map<String,Map<String,ClassElement>>	getAllTypeArguments()	Builds a map of all the type parameters for a class, its super classes and interfaces.
@NonNull AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
protected MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
int	getArrayDimensions()	If the type is an array, the number of dimensions.
@NonNull List<PropertyElement>	getBeanProperties()	Returns the bean properties (getters and setters) for this class element.
@NonNull List<PropertyElement>	getBeanProperties(@NonNull PropertyElementQuery propertyElementQuery)	Returns the bean properties (getters and setters) for this class element based on custom configuration.
@NonNull List<ClassElement>	getBoundGenericTypes()	The list of type arguments bound to this type, or an empty list if there are no type arguments or this is a raw type.
String	getCanonicalName()	This method will return the name of the underlying type automatically unwrapping in the case of an optional or wrapped representation of the type.
@NonNull List<? extends GenericPlaceholderElement>	getDeclaredGenericPlaceholders()	The type arguments declared on the raw class.
<T extends Element> @NonNull List<T>	getEnclosedElements(@NonNull ElementQuery<T> query)	Return the elements that match the given query.
Optional<ClassElement>	getEnclosingType()	Returns the enclosing type if ClassElement.isInner() return true.
Collection<ClassElement>	getInterfaces()
@NonNull String	getName()
@NonNull JavaNativeElement.Class	getNativeType()	Returns the native underlying type.
Optional<ClassElement>	getOptionalValueType()	Gets optional value type.
PackageElement	getPackage()	The package name.
String	getPackageName()	The package name.
@NonNull Optional<MethodElement>	getPrimaryConstructor()	Find and return a single primary constructor.
@NonNull ClassElement	getRawClassElement()	Get a ClassElement instance corresponding to this type, but without any type arguments bound.
@NonNull String	getSimpleName()	The simple name without the package name.
final <T extends Element> List<T>	getSourceEnclosedElements(@NonNull ElementQuery<T> query)	This method will produce the elements just like getEnclosedElements(ElementQuery) but the elements are constructed as the source ones.
Optional<ClassElement>	getSuperType()	Returns the super type of this element or empty if the element has no super type.
@NonNull ClassElement	getType()
@NonNull MutableAnnotationMetadataDelegate<AnnotationMetadata>	getTypeAnnotationMetadata()	Returns the type annotations.
@NonNull Map<String,ClassElement>	getTypeArguments()
boolean	isAbstract()
boolean	isArray()	Is the type an array.
boolean	isAssignable(ClassElement type)	Tests whether one type is assignable to another.
boolean	isAssignable(String type)	Tests whether one type is assignable to another.
boolean	isInner()	Is this type an inner class.
boolean	isInterface()
boolean	isPrimitive()	Whether the type is primitive.
boolean	isRecord()
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.
String	toString()
ClassElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.
ClassElement	withArrayDimensions(int arrayDimensions)	Convert the class element to an element for the same type, but with the given number of array dimensions.
@NonNull ClassElement	withTypeArguments(@NonNull Collection<ClassElement> typeArguments)	Copies this element and overrides its type arguments.
@NonNull ClassElement	withTypeArguments(Map<String,ClassElement> newTypeArguments)	Copies this element and overrides its type arguments.

Methods inherited from class io.micronaut.annotation.processing.visitor.AbstractJavaElement

copyValues, equals, getDocumentation, getModifiers, hashCode, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, makeCopy, newClassElement, newClassElement, resolveTypeArguments, resolveTypeArguments

Methods inherited from class io.micronaut.inject.ast.annotation.AbstractAnnotationElement

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micronaut.core.annotation.AnnotatedElement

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasEvaluatedExpressions, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.core.annotation.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, 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 io.micronaut.inject.ast.ArrayableClassElement

fromArray, toArray

Methods inherited from interface io.micronaut.inject.ast.ClassElement

addAssociatedBean, findDefaultStaticCreator, findField, findMethod, findStaticCreator, foldBoundGenericTypes, getAccessibleConstructors, getDefaultConstructor, getEnclosedElement, getFields, getFirstTypeArgument, getMethods, getSyntheticBeanProperties, getTypeArguments, getTypeArguments, isAssignable, isContainerType, isEnum, isGenericPlaceholder, isIterable, isOptional, isProxy, isRawType, isWildcard, withBoundGenericTypes

Methods inherited from interface io.micronaut.inject.ast.Element

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

Methods inherited from interface io.micronaut.inject.ast.TypedElement

getGenericType, isVoid

Field Details

classElement

protected final TypeElement classElement

arrayDimensions

protected final int arrayDimensions

Constructor Details

JavaClassElement

@Internal
public JavaClassElement(JavaNativeElement.Class nativeType,
 ElementAnnotationMetadataFactory annotationMetadataFactory,
 JavaVisitorContext visitorContext)

Parameters:

nativeType - The native type

annotationMetadataFactory - The annotation metadata factory

visitorContext - The visitor context

Method Details

getCanonicalName

public String getCanonicalName()

Description copied from interface: ClassElement

This method will return the name of the underlying type automatically unwrapping in the case of an optional or wrapped representation of the type.

Specified by:

getCanonicalName in interface ClassElement

Returns:

Returns the canonical name of the type.

getNativeType

public @NonNull JavaNativeElement.Class 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

Overrides:

getNativeType in class AbstractJavaElement

Returns:

The native type

copyThis

protected JavaClassElement copyThis()

Specified by:

copyThis in class AbstractJavaElement

Returns:

copy of this element

withTypeArguments

@NonNull
public @NonNull ClassElement withTypeArguments(Map<String,ClassElement> newTypeArguments)

Description copied from interface: ClassElement

Copies this element and overrides its type arguments.

Specified by:

withTypeArguments in interface ClassElement

Parameters:

newTypeArguments - The type arguments

Returns:

A new element

withAnnotationMetadata

public ClassElement withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Specified by:

withAnnotationMetadata in interface ClassElement

Specified by:

withAnnotationMetadata in interface Element

Overrides:

withAnnotationMetadata in class AbstractJavaElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

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

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 AbstractAnnotationElement

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

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.

toString

public String toString()

Overrides:

toString in class AbstractJavaElement

isInner

public boolean isInner()

Description copied from interface: ClassElement

Is this type an inner class.

Specified by:

isInner in interface ClassElement

Returns:

True if it is an inner class

isRecord

public boolean isRecord()

Specified by:

isRecord in interface ClassElement

Returns:

Whether this element is a record

isPrimitive

public boolean isPrimitive()

Description copied from interface: TypedElement

Whether the type is primitive.

Specified by:

isPrimitive in interface TypedElement

Returns:

True if it is

getInterfaces

public Collection<ClassElement> getInterfaces()

Specified by:

getInterfaces in interface ClassElement

Returns:

The interfaces implemented by this class element

getSuperType

public Optional<ClassElement> getSuperType()

Description copied from interface: ClassElement

Returns the super type of this element or empty if the element has no super type.

Specified by:

getSuperType in interface ClassElement

Returns:

An optional of the super type

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface Element

Overrides:

isAbstract in class AbstractJavaElement

Returns:

True if the element is abstract.

isInterface

public boolean isInterface()

Specified by:

isInterface in interface ClassElement

Returns:

Whether the class element is an interface

getBeanProperties

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

Returns:

The bean properties for this class element

getBeanProperties

@NonNull
public @NonNull List<PropertyElement> getBeanProperties(@NonNull
 @NonNull 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

Parameters:

propertyElementQuery - The configuration

Returns:

The bean properties for this class element

getEnclosedElements

@NonNull
public <T extends Element> @NonNull List<T> getEnclosedElements(@NonNull
 @NonNull ElementQuery<T> query)

Description copied from interface: ClassElement

Return the elements that match the given query.

Specified by:

getEnclosedElements in interface ClassElement

Type Parameters:

T - The element type

Parameters:

query - The query to use.

Returns:

The fields

getSourceEnclosedElements

public final <T extends Element> List<T> getSourceEnclosedElements(@NonNull
 @NonNull ElementQuery<T> query)

This method will produce the elements just like getEnclosedElements(ElementQuery) but the elements are constructed as the source ones. ElementFactory.newSourceMethodElement(ClassElement, Object, ElementAnnotationMetadataFactory).

Type Parameters:

T - The element type

Parameters:

query - The query

Returns:

The list of elements

isArray

public boolean isArray()

Description copied from interface: TypedElement

Is the type an array.

Specified by:

isArray in interface TypedElement

Returns:

True if it is.

getArrayDimensions

public int getArrayDimensions()

Description copied from interface: TypedElement

If the type is an array, the number of dimensions. String[] should return 1, String[][] should return 2

Specified by:

getArrayDimensions in interface TypedElement

Returns:

The number of dimensions

withArrayDimensions

public ClassElement withArrayDimensions(int arrayDimensions)

Description copied from interface: ArrayableClassElement

Convert the class element to an element for the same type, but with the given number of array dimensions. Do not mutate the existing instance. Create a new instance instead.

Specified by:

withArrayDimensions in interface ArrayableClassElement

Parameters:

arrayDimensions - The number of array dimensions of the new class element

Returns:

A new class element

getSimpleName

@NonNull
public @NonNull String getSimpleName()

Description copied from interface: ClassElement

The simple name without the package name.

Specified by:

getSimpleName in interface ClassElement

Specified by:

getSimpleName in interface Element

Returns:

The simple name

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface Element

Specified by:

getName in interface Named

Overrides:

getName in class AbstractJavaElement

Returns:

The name of the element. For a type this represents the binary name.

getPackageName

public String getPackageName()

Description copied from interface: ClassElement

The package name.

Specified by:

getPackageName in interface ClassElement

Returns:

The package name

getPackage

public PackageElement getPackage()

Description copied from interface: ClassElement

The package name.

Specified by:

getPackage in interface ClassElement

Returns:

The package name

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

isAssignable

public boolean isAssignable(ClassElement 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

getOptionalValueType

public Optional<ClassElement> getOptionalValueType()

Description copied from interface: ClassElement

Gets optional value type.

Specified by:

getOptionalValueType in interface ClassElement

Returns:

the value type

getPrimaryConstructor

@NonNull
public @NonNull Optional<MethodElement> getPrimaryConstructor()

Description copied from interface: ClassElement

Find and return a single primary constructor. If more than constructor candidate exists, then return empty unless a constructor is found that is annotated with either Creator or AnnotationUtil.INJECT.

Specified by:

getPrimaryConstructor in interface ClassElement

Returns:

The primary constructor if one is present

getAccessibleStaticCreators

@NonNull
public @NonNull List<MethodElement> getAccessibleStaticCreators()

Description copied from interface: ClassElement

Get accessible static creators. A static creator is a static method annotated with Creator that can be used to create the class. For enums "valueOf" is picked as a static creator.

Specified by:

getAccessibleStaticCreators in interface ClassElement

Returns:

static creators

getEnclosingType

public Optional<ClassElement> getEnclosingType()

Description copied from interface: ClassElement

Returns the enclosing type if ClassElement.isInner() return true.

Specified by:

getEnclosingType in interface ClassElement

Returns:

The enclosing type if any

getBoundGenericTypes

@NonNull
public @NonNull List<ClassElement> getBoundGenericTypes()

Description copied from interface: ClassElement

The list of type arguments bound to this type, or an empty list if there are no type arguments or this is a raw type.

Note that for compatibility reasons, this method is inconsistent with ClassElement.getTypeArguments(). In particular, this method reflects the declaration type: If there is a class Test<T> { T field; }, this method will return T as the field type, even if the field type was obtained through a Test<String>.

Specified by:

getBoundGenericTypes in interface ClassElement

Returns:

The list of type arguments, in the same order as ClassElement.getDeclaredGenericPlaceholders(). Must be empty or of the same length as ClassElement.getDeclaredGenericPlaceholders().

getDeclaredGenericPlaceholders

@NonNull
public @NonNull List<? extends GenericPlaceholderElement> getDeclaredGenericPlaceholders()

Description copied from interface: ClassElement

The type arguments declared on the raw class. Independent of the actual bound type arguments.

This method will resolve the generic placeholders defined of the declaring class, if any.

For example List<String> will result a single placeholder called E of type Object.

Specified by:

getDeclaredGenericPlaceholders in interface ClassElement

Returns:

The type arguments declared on this class.

getRawClassElement

@NonNull
public @NonNull ClassElement getRawClassElement()

Description copied from interface: ClassElement

Get a ClassElement instance corresponding to this type, but without any type arguments bound. For List<String>, this returns List.

Specified by:

getRawClassElement in interface ClassElement

Returns:

The raw class of this potentially parameterized type.

withTypeArguments

@NonNull
public @NonNull ClassElement withTypeArguments(@NonNull
 @NonNull Collection<ClassElement> typeArguments)

Description copied from interface: ClassElement

Copies this element and overrides its type arguments. Variation of ClassElement.withTypeArguments(Map) that doesn't require type argument names.

Specified by:

withTypeArguments in interface ClassElement

Parameters:

typeArguments - The type arguments

Returns:

A new element

getTypeArguments

@NonNull
public @NonNull Map<String,ClassElement> getTypeArguments()

Specified by:

getTypeArguments in interface ClassElement

Returns:

The type arguments for this class element

getAllTypeArguments

@NonNull
public @NonNull Map<String,Map<String,ClassElement>> getAllTypeArguments()

Description copied from interface: ClassElement

Builds a map of all the type parameters for a class, its super classes and interfaces. The resulting map contains the name of the class to the map of the resolved generic types.

Specified by:

getAllTypeArguments in interface ClassElement

Returns:

The type arguments for this class element

getType

@NonNull
public @NonNull ClassElement getType()

Specified by:

getType in interface ClassElement

Specified by:

getType in interface TypedElement

Returns:

The type of the element