io.micronaut.annotation.processing.visitor

Class JavaClassElement

java.lang.Object

io.micronaut.annotation.processing.visitor.AbstractJavaElement

io.micronaut.annotation.processing.visitor.JavaClassElement

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Named, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.lang.model.element.TypeElement	classElement
protected JavaVisitorContext	visitorContext

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

EMPTY_ELEMENT_ARRAY

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

Constructor Summary

Constructors

Constructor and Description
JavaClassElement(javax.lang.model.element.TypeElement classElement, AnnotationMetadata annotationMetadata, JavaVisitorContext visitorContext)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Map<java.lang.String,ClassElement>>	getAllTypeArguments() Builds a map of all the type parameters for a class, its super classes and interfaces.
int	getArrayDimensions() If the type is an array, the number of dimensions.
java.util.List<PropertyElement>	getBeanProperties() Returns the bean properties (getters and setters) for this class element.
java.util.Optional<MethodElement>	getDefaultConstructor() Find and return a single default constructor.
<T extends Element> java.util.List<T>	getEnclosedElements(ElementQuery<T> query) Return the elements that match the given query.
java.lang.String	getName()
java.lang.String	getPackageName() The package name.
java.util.Optional<MethodElement>	getPrimaryConstructor() Find and return a single primary constructor.
java.lang.String	getSimpleName() The simple name without the package name.
java.util.Optional<ClassElement>	getSuperType() Returns the super type of this element or empty if the element has no super type.
java.util.Map<java.lang.String,ClassElement>	getTypeArguments()
java.util.Map<java.lang.String,ClassElement>	getTypeArguments(java.lang.String type) Get the type arguments for the given type name.
boolean	isAbstract()
boolean	isArray() Is the type an array.
boolean	isAssignable(ClassElement type) Tests whether one type is assignable to another.
boolean	isAssignable(java.lang.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()
ClassElement	withArrayDimensions(int arrayDimensions) Convert the class element to an element for the same type, but with the given number of array dimensions.

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

annotate, getAnnotationMetadata, getNativeType, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, mirrorToClassElement, mirrorToClassElement, mirrorToClassElement, parameterizedClassElement, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fromArray, toArray

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

getCanonicalName, getEnclosedElement, getFields, getFields, getFirstTypeArgument, getType, getTypeArguments, isAssignable, isEnum, isIterable, isOptional, of, of, of

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

getGenericType

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

annotate, annotate, annotate, annotate, getDocumentation, getNativeType, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

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

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, 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, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

hasDeclaredStereotype

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

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

getAnnotationMetadata

Field Detail

classElement

protected final javax.lang.model.element.TypeElement classElement

visitorContext

protected final JavaVisitorContext visitorContext

Constructor Detail

JavaClassElement

@Internal
public JavaClassElement(javax.lang.model.element.TypeElement classElement,
                                  AnnotationMetadata annotationMetadata,
                                  JavaVisitorContext visitorContext)

Parameters:

classElement - The TypeElement

annotationMetadata - The annotation metadata

visitorContext - The visitor context

Method Detail

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

getTypeArguments

@NonNull
public java.util.Map<java.lang.String,ClassElement> getTypeArguments(@NonNull
                                                                              java.lang.String type)

Description copied from interface: ClassElement

Get the type arguments for the given type name.

Specified by:

getTypeArguments in interface ClassElement

Parameters:

type - The type to retrieve type arguments for

Returns:

The type arguments for this class element

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

getSuperType

public java.util.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

public java.util.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

getEnclosedElements

public <T extends Element> java.util.List<T> getEnclosedElements(@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

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

public java.lang.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

public java.lang.String getName()

Specified by:

getName in interface Named

Specified by:

getName in interface Element

Overrides:

getName in class AbstractJavaElement

Returns:

The name of the element.

getPackageName

public java.lang.String getPackageName()

Description copied from interface: ClassElement

The package name.

Specified by:

getPackageName in interface ClassElement

Returns:

The package name

isAssignable

public boolean isAssignable(java.lang.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 the 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 the this type is assignable to the second

getPrimaryConstructor

@NonNull
public java.util.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 Inject.

Specified by:

getPrimaryConstructor in interface ClassElement

Returns:

The primary constructor if one is present

getDefaultConstructor

public java.util.Optional<MethodElement> getDefaultConstructor()

Description copied from interface: ClassElement

Find and return a single default constructor. A default constructor is one without arguments that is accessible.

Specified by:

getDefaultConstructor in interface ClassElement

Returns:

The default constructor if one is present

getTypeArguments

@NonNull
public java.util.Map<java.lang.String,ClassElement> getTypeArguments()

Specified by:

getTypeArguments in interface ClassElement

Returns:

The type arguments for this class element

getAllTypeArguments

@NonNull
public java.util.Map<java.lang.String,java.util.Map<java.lang.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 a map of the resolved generic types.

Specified by:

getAllTypeArguments in interface ClassElement

Returns:

The type arguments for this class element