io.micronaut.inject.ast

Interface ClassElement

All Superinterfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Element, Named, TypedElement

All Known Subinterfaces:

ArrayableClassElement, EnumElement

All Known Implementing Classes:

GroovyClassElement, JavaClassElement, PrimitiveElement

public interface ClassElement
extends TypedElement

Stores data about an element that references a class.

Since:

1.0

Author:

James Kleeh, graemerocher

Field Summary

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

Method Summary

Modifier and Type	Method and Description
ClassElement	fromArray() Dereference a class element denoting an array type by converting it to its element type.
default 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.
default java.util.List<PropertyElement>	getBeanProperties() Returns the bean properties (getters and setters) for this class element.
default java.lang.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.
default java.util.Optional<MethodElement>	getDefaultConstructor() Find and return a single default constructor.
default <T extends Element> java.util.Optional<T>	getEnclosedElement(ElementQuery<T> query) Return the first enclosed element matching the given query.
default <T extends Element> java.util.List<T>	getEnclosedElements(ElementQuery<T> query) Return the elements that match the given query.
default java.util.List<FieldElement>	getFields() Return all the fields of this class element.
default java.util.List<FieldElement>	getFields(java.util.function.Predicate<java.util.Set<ElementModifier>> modifierFilter) Deprecated. Use getEnclosedElements(ElementQuery) instead
default java.util.Optional<ClassElement>	getFirstTypeArgument()
default java.lang.String	getPackageName() The package name.
default java.util.Optional<MethodElement>	getPrimaryConstructor() Find and return a single primary constructor.
default java.lang.String	getSimpleName() The simple name without the package name.
default java.util.Optional<ClassElement>	getSuperType() Returns the super type of this element or empty if the element has no super type.
default ClassElement	getType()
default java.util.Map<java.lang.String,ClassElement>	getTypeArguments()
default java.util.Map<java.lang.String,ClassElement>	getTypeArguments(java.lang.Class<?> type) Get the type arguments for the given type name.
default java.util.Map<java.lang.String,ClassElement>	getTypeArguments(java.lang.String type) Get the type arguments for the given type name.
default boolean	isAssignable(java.lang.Class<?> type) Tests whether one type is assignable to another.
default 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.
default boolean	isEnum() Whether this element is an enum.
default boolean	isInner() Is this type an inner class.
default boolean	isInterface()
default boolean	isIterable()
default boolean	isOptional() Whether this element is an Optional.
default boolean	isRecord()
static ClassElement	of(java.lang.Class<?> type) Create a class element for the given simple type.
static ClassElement	of(java.lang.String typeName) Create a class element for the given simple type.
ClassElement	toArray() Convert the class element to an element for the same type, but representing an array.

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

getArrayDimensions, getGenericType, isArray, isPrimitive

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

annotate, annotate, annotate, annotate, getDocumentation, getName, getNativeType, isAbstract, 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, 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

Method Detail

isAssignable

boolean isAssignable(java.lang.String type)

Tests whether one type is assignable to another.

Parameters:

type - The type to check

Returns:

true if and only if the this type is assignable to the second

isAssignable

default boolean isAssignable(ClassElement type)

Tests whether one type is assignable to another.

Parameters:

type - The type to check

Returns:

true if and only if the this type is assignable to the second

Since:

2.3.0

isOptional

default boolean isOptional()

Whether this element is an Optional.

Returns:

Is this element an optional

Since:

2.3.0

getCanonicalName

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

Returns:

Returns the canonical name of the type.

Since:

2.3.0

isRecord

default boolean isRecord()

Returns:

Whether this element is a record

Since:

2.1.0

isInner

default boolean isInner()

Is this type an inner class.

Returns:

True if it is an inner class

Since:

2.1.2

isEnum

default boolean isEnum()

Whether this element is an enum.

Returns:

True if it is an enum

getPrimaryConstructor

@NonNull
default java.util.Optional<MethodElement> getPrimaryConstructor()

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.

Returns:

The primary constructor if one is present

getDefaultConstructor

@NonNull
default java.util.Optional<MethodElement> getDefaultConstructor()

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

Returns:

The default constructor if one is present

getSuperType

default java.util.Optional<ClassElement> getSuperType()

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

Returns:

An optional of the super type

getType

@NonNull
default ClassElement getType()

Specified by:

getType in interface TypedElement

Returns:

The type of the element

getSimpleName

default java.lang.String getSimpleName()

The simple name without the package name.

Specified by:

getSimpleName in interface Element

Returns:

The simple name

getPackageName

default java.lang.String getPackageName()

The package name.

Returns:

The package name

getBeanProperties

default java.util.List<PropertyElement> getBeanProperties()

Returns the bean properties (getters and setters) for this class element.

Returns:

The bean properties for this class element

getFields

default java.util.List<FieldElement> getFields()

Return all the fields of this class element.

Returns:

The fields

getFields

@Deprecated
default java.util.List<FieldElement> getFields(@NonNull
                                                           java.util.function.Predicate<java.util.Set<ElementModifier>> modifierFilter)

Deprecated. Use getEnclosedElements(ElementQuery) instead

Return fields contained with the given modifiers include / exclude rules.

Parameters:

modifierFilter - Can be used to filter fields by modifier

Returns:

The fields

getEnclosedElements

default <T extends Element> java.util.List<T> getEnclosedElements(@NonNull
                                                                  ElementQuery<T> query)

Return the elements that match the given query.

Type Parameters:

T - The element type

Parameters:

query - The query to use.

Returns:

The fields

Since:

2.3.0

getEnclosedElement

default <T extends Element> java.util.Optional<T> getEnclosedElement(@NonNull
                                                                     ElementQuery<T> query)

Return the first enclosed element matching the given query.

Type Parameters:

T - The element type

Parameters:

query - The query to use.

Returns:

The fields

Since:

2.3.0

isInterface

default boolean isInterface()

Returns:

Whether the class element is an interface

isIterable

default boolean isIterable()

Returns:

Whether the type is iterable (either an array or an Iterable)

getTypeArguments

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

Get the type arguments for the given type name.

Parameters:

type - The type to retrieve type arguments for

Returns:

The type arguments for this class element

Since:

1.1.1

getTypeArguments

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

Get the type arguments for the given type name.

Parameters:

type - The type to retrieve type arguments for

Returns:

The type arguments for this class element

getTypeArguments

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

Returns:

The type arguments for this class element

getAllTypeArguments

@NonNull
default 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. The resulting map contains the name of the class to the a map of the resolved generic types.

Returns:

The type arguments for this class element

getFirstTypeArgument

default java.util.Optional<ClassElement> getFirstTypeArgument()

Returns:

The first type argument

isAssignable

default boolean isAssignable(java.lang.Class<?> type)

Tests whether one type is assignable to another.

Parameters:

type - The type to check

Returns:

true if and only if the this type is assignable to the second

toArray

ClassElement toArray()

Convert the class element to an element for the same type, but representing an array. Do not mutate the existing instance. Create a new instance instead.

Returns:

A new class element

fromArray

ClassElement fromArray()

Dereference a class element denoting an array type by converting it to its element type. Do not mutate the existing instance. Create a new instance instead.

Returns:

A new class element

Throws:

java.lang.IllegalStateException - if this class element doesn't denote an array type

of

static ClassElement of(java.lang.Class<?> type)

Create a class element for the given simple type.

Parameters:

type - The type

Returns:

The class element

of

@Internal
static ClassElement of(java.lang.String typeName)

Create a class element for the given simple type.

Parameters:

typeName - The type

Returns:

The class element