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, ClassElement, Element, TypedElement

@Internal
public class JavaClassElement
extends AbstractJavaElement
implements ClassElement

A class element returning data from a TypeElement.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaClassElement(TypeElement classElement, AnnotationMetadata annotationMetadata, JavaVisitorContext visitorContext)

Method Summary

Modifier and Type	Method and Description
AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
List<PropertyElement>	getBeanProperties() Returns the bean properties (getters and setters) for this class element.
List<FieldElement>	getFields(Predicate<Set<ElementModifier>> modifierFilter) Return fields contained with the given modifiers include / exclude rules.
String	getName()
Optional<ConstructorElement>	getPrimaryConstructor() Find and return a single primary constructor.
Optional<ClassElement>	getSuperType() Returns the super type of this element or empty if the element has no super type.
Map<String,ClassElement>	getTypeArguments()
Map<String,ClassElement>	getTypeArguments(String type) Get the type arguments for the given type name.
boolean	hasDefaultConstructor()
boolean	isAbstract()
boolean	isArray() Returns whether the class element is an array.
boolean	isAssignable(String type) Tests whether one type is assignable to another.
boolean	isInterface()
boolean	isPrimitive() Whether the type is primitive.

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

annotate, getNativeType, isFinal, isPrivate, isProtected, isPublic, isStatic, 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.ClassElement

getFields, getFirstTypeArgument, getPackageName, getSimpleName, getType, getTypeArguments, isAssignable, isEnum, isIterable

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, 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

Constructor Detail

JavaClassElement

protected JavaClassElement(TypeElement classElement,
                           AnnotationMetadata annotationMetadata,
                           JavaVisitorContext visitorContext)

Parameters:

classElement - The TypeElement

annotationMetadata - The annotation metadata

visitorContext - The visitor context

Method Detail

getTypeArguments

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

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

getFields

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

Description copied from interface: ClassElement

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

Specified by:

getFields in interface ClassElement

Parameters:

modifierFilter - Can be used to filter fields by modifier

Returns:

The fields

isArray

public boolean isArray()

Description copied from interface: ClassElement

Returns whether the class element is an array.

Specified by:

isArray in interface ClassElement

Specified by:

isArray in interface TypedElement

Returns:

True if this class element is an array

getName

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

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 the this type is assignable to the second

getAnnotationMetadata

public 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 AbstractJavaElement

Returns:

The AnnotationMetadata

getPrimaryConstructor

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

hasDefaultConstructor

public boolean hasDefaultConstructor()

Specified by:

hasDefaultConstructor in interface ClassElement

Returns:

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

getTypeArguments

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

Specified by:

getTypeArguments in interface ClassElement

Returns:

The type arguments for this class element