io.micronaut.annotation.processing.visitor

Class AbstractJavaElement

java.lang.Object

io.micronaut.annotation.processing.visitor.AbstractJavaElement

All Implemented Interfaces:

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

Direct Known Subclasses:

JavaClassElement, JavaMethodElement, JavaPackageElement

public abstract class AbstractJavaElement
extends Object
implements Element

An abstract class for other elements to extend from.

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
<T extends Annotation> Element	annotate(AnnotationValue<T> annotationValue) Annotate this element with the given annotation type.
<T extends Annotation> Element	annotate(String annotationType, Consumer<AnnotationValueBuilder<T>> consumer) Annotate this element with the given annotation type.
boolean	equals(Object o)
AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
Optional<String>	getDocumentation()
Set<ElementModifier>	getModifiers()
String	getName()
Object	getNativeType() Returns the native underlying type.
int	hashCode()
boolean	isAbstract()
boolean	isFinal()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
protected ClassElement	mirrorToClassElement(TypeMirror returnType, JavaVisitorContext visitorContext) Obtain the ClassElement for the given mirror.
protected ClassElement	mirrorToClassElement(TypeMirror returnType, JavaVisitorContext visitorContext, Map<String,Map<String,TypeMirror>> genericsInfo) Obtain the ClassElement for the given mirror.
protected ClassElement	mirrorToClassElement(TypeMirror returnType, JavaVisitorContext visitorContext, Map<String,Map<String,TypeMirror>> genericsInfo, boolean includeTypeAnnotations) Obtain the ClassElement for the given mirror.
protected ClassElement	mirrorToClassElement(TypeMirror returnType, JavaVisitorContext visitorContext, Map<String,Map<String,TypeMirror>> genericsInfo, boolean includeTypeAnnotations, boolean isTypeVariable) Obtain the ClassElement for the given mirror.
protected ClassElement	parameterizedClassElement(TypeMirror typeMirror, JavaVisitorContext visitorContext, Map<String,Map<String,TypeMirror>> declaredGenericInfo) Returns a class element with aligned generic information.
Element	removeAnnotation(String annotationType) Removes an annotation of the given type from the element.
<T extends Annotation> Element	removeAnnotationIf(Predicate<AnnotationValue<T>> predicate) Removes all annotations that pass the given predicate.
Element	removeStereotype(String annotationType) Removes a stereotype of the given name from the element.
String	toString()

Methods inherited from class java.lang.Object

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

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

annotate, annotate, annotate, getDescription, getDescription, getSimpleName, removeAnnotation, removeStereotype

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, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, 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.core.annotation.AnnotationMetadata

getAnnotationValuesByName, getAnnotationValuesByStereotype, getDeclaredAnnotationValuesByName, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Method Detail

annotate

@NonNull
public <T extends Annotation> Element annotate(@NonNull
                                                        String annotationType,
                                                        @NonNull
                                                        Consumer<AnnotationValueBuilder<T>> consumer)

Description copied from interface: Element

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Specified by:

annotate in interface Element

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

consumer - A function that receives the AnnotationValueBuilder

Returns:

This element

annotate

public <T extends Annotation> Element annotate(AnnotationValue<T> annotationValue)

Description copied from interface: Element

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Specified by:

annotate in interface Element

Type Parameters:

T - The annotation generic type

Parameters:

annotationValue - The annotation type

Returns:

This element

removeAnnotation

public Element removeAnnotation(@NonNull
                                String annotationType)

Description copied from interface: Element

Removes an annotation of the given type from the element.

If the annotation features any stereotypes these will also be removed unless there are other annotations that reference the stereotype to be removed.

In the case of repeatable annotations this method will remove all repeated annotations, effectively clearing out all declared repeated annotations of the given type.

Specified by:

removeAnnotation in interface Element

Parameters:

annotationType - The annotation type

Returns:

This element

removeAnnotationIf

public <T extends Annotation> Element removeAnnotationIf(@NonNull
                                                         Predicate<AnnotationValue<T>> predicate)

Description copied from interface: Element

Removes all annotations that pass the given predicate.

Specified by:

removeAnnotationIf in interface Element

Type Parameters:

T - The annotation generic type

Parameters:

predicate - The predicate

Returns:

This element

removeStereotype

public Element removeStereotype(@NonNull
                                String annotationType)

Description copied from interface: Element

Removes a stereotype of the given name from the element.

Specified by:

removeStereotype in interface Element

Parameters:

annotationType - The annotation type

Returns:

This element

isPackagePrivate

public boolean isPackagePrivate()

Specified by:

isPackagePrivate in interface Element

Returns:

True if the element is package private.

getName

public String getName()

Specified by:

getName in interface Named

Specified by:

getName in interface Element

Returns:

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

getModifiers

public Set<ElementModifier> getModifiers()

Specified by:

getModifiers in interface Element

Returns:

The ElementModifier types for this class element

getDocumentation

public Optional<String> getDocumentation()

Specified by:

getDocumentation in interface Element

Returns:

The documentation, if any.

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface Element

Returns:

True if the element is abstract.

isStatic

public boolean isStatic()

Specified by:

isStatic in interface Element

Returns:

True if the element is static.

isPublic

public boolean isPublic()

Specified by:

isPublic in interface Element

Returns:

True if the element is public.

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface Element

Returns:

True if the element is private.

isFinal

public boolean isFinal()

Specified by:

isFinal in interface Element

Returns:

True if the element is final.

isProtected

public boolean isProtected()

Specified by:

isProtected in interface Element

Returns:

True if the element is protected.

getNativeType

public Object getNativeType()

Description copied from interface: Element

Returns the native underlying type. This API is extended by all of the 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

Returns:

The native type

getAnnotationMetadata

public AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

toString

public String toString()

Overrides:

toString in class Object

parameterizedClassElement

@NonNull
protected ClassElement parameterizedClassElement(TypeMirror typeMirror,
                                                          JavaVisitorContext visitorContext,
                                                          Map<String,Map<String,TypeMirror>> declaredGenericInfo)

Returns a class element with aligned generic information.

Parameters:

typeMirror - The type mirror

visitorContext - The visitor context

declaredGenericInfo - The declared generic info

Returns:

The class element

mirrorToClassElement

@NonNull
protected ClassElement mirrorToClassElement(TypeMirror returnType,
                                                     JavaVisitorContext visitorContext)

Obtain the ClassElement for the given mirror.

Parameters:

returnType - The return type

visitorContext - The visitor context

Returns:

The class element

mirrorToClassElement

@NonNull
protected ClassElement mirrorToClassElement(TypeMirror returnType,
                                                     JavaVisitorContext visitorContext,
                                                     Map<String,Map<String,TypeMirror>> genericsInfo)

Obtain the ClassElement for the given mirror.

Parameters:

returnType - The return type

visitorContext - The visitor context

genericsInfo - The generic information.

Returns:

The class element

mirrorToClassElement

@NonNull
protected ClassElement mirrorToClassElement(TypeMirror returnType,
                                                     JavaVisitorContext visitorContext,
                                                     Map<String,Map<String,TypeMirror>> genericsInfo,
                                                     boolean includeTypeAnnotations)

Obtain the ClassElement for the given mirror.

Parameters:

returnType - The return type

visitorContext - The visitor context

genericsInfo - The generic information.

includeTypeAnnotations - Whether to include type level annotations in the metadata for the element

Returns:

The class element

mirrorToClassElement

@NonNull
protected ClassElement mirrorToClassElement(TypeMirror returnType,
                                                     JavaVisitorContext visitorContext,
                                                     Map<String,Map<String,TypeMirror>> genericsInfo,
                                                     boolean includeTypeAnnotations,
                                                     boolean isTypeVariable)

Obtain the ClassElement for the given mirror.

Parameters:

returnType - The return type

visitorContext - The visitor context

genericsInfo - The generic information.

includeTypeAnnotations - Whether to include type level annotations in the metadata for the element

isTypeVariable - is the type a type variable

Returns:

The class element

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object