io.micronaut.inject.ast

Interface ClassElement

All Superinterfaces:

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

All Known Subinterfaces:

EnumElement

All Known Implementing Classes:

GroovyClassElement, JavaClassElement, JavaPrimitiveElement

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.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
default List<PropertyElement>	getBeanProperties() Returns the bean properties (getters and setters) for this class element.
default List<FieldElement>	getFields() Return all the fields of this class element.
default List<FieldElement>	getFields(Predicate<Set<ElementModifier>> modifierFilter) Return fields contained with the given modifiers include / exclude rules.
default Optional<ClassElement>	getFirstTypeArgument()
default String	getPackageName() The package name.
default Optional<ConstructorElement>	getPrimaryConstructor() Find and return a single primary constructor.
default String	getSimpleName() The simple name without the package name.
default Optional<ClassElement>	getSuperType() Returns the super type of this element or empty if the element has no super type.
default ClassElement	getType()
default Map<String,ClassElement>	getTypeArguments()
default Map<String,ClassElement>	getTypeArguments(Class<?> type) Get the type arguments for the given type name.
default Map<String,ClassElement>	getTypeArguments(String type) Get the type arguments for the given type name.
default boolean	hasDefaultConstructor()
default boolean	isAbstract()
default boolean	isArray() Returns whether the class element is an array.
default boolean	isAssignable(Class<?> type) Tests whether one type is assignable to another.
boolean	isAssignable(String type) Tests whether one type is assignable to another.
default boolean	isEnum() Whether this element is an enum.
default boolean	isInterface()
default boolean	isIterable()

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

getGenericType, isPrimitive

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

annotate, annotate, annotate, annotate, getDocumentation, getName, getNativeType, isFinal, 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, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, 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, 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

hasSimpleAnnotation, hasSimpleDeclaredAnnotation

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

isDeclaredNullable, isNullable

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

getAnnotationMetadata

Method Detail

isAssignable

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

isEnum

default boolean isEnum()

Whether this element is an enum.

Returns:

True if it is an enum

getPrimaryConstructor

@Nonnull
default Optional<ConstructorElement> 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

hasDefaultConstructor

default boolean hasDefaultConstructor()

Returns:

True if the class has a non private constructor with no arguments.

getSuperType

default 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 String getSimpleName()

The simple name without the package name.

Specified by:

getSimpleName in interface Element

Returns:

The simple name

getPackageName

default String getPackageName()

The package name.

Returns:

The package name

getBeanProperties

default List<PropertyElement> getBeanProperties()

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

Returns:

The bean properties for this class element

getFields

default List<FieldElement> getFields()

Return all the fields of this class element.

Returns:

The fields

getFields

default List<FieldElement> getFields(@Nonnull
                                     Predicate<Set<ElementModifier>> modifierFilter)

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

Parameters:

modifierFilter - Can be used to filter fields by modifier

Returns:

The fields

isAbstract

default boolean isAbstract()

Specified by:

isAbstract in interface Element

Returns:

Whether the class element is abstract

isInterface

default boolean isInterface()

Returns:

Whether the class element is an interface

isArray

default boolean isArray()

Returns whether the class element is an array.

Specified by:

isArray in interface TypedElement

Returns:

True if this class element is an array

isIterable

default boolean isIterable()

Returns:

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

getTypeArguments

@Nonnull
default Map<String,ClassElement> getTypeArguments(@Nonnull
                                                           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 Map<String,ClassElement> getTypeArguments(@Nonnull
                                                           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 Map<String,ClassElement> getTypeArguments()

Returns:

The type arguments for this class element

getFirstTypeArgument

default Optional<ClassElement> getFirstTypeArgument()

Returns:

The first type argument

isAssignable

default boolean isAssignable(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