Package io.micronaut.annotation.processing.visitor

Class AbstractJavaElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.annotation.processing.visitor.AbstractJavaElement

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, MutableAnnotationMetadataDelegate<Element>, Element

Direct Known Subclasses:

AbstractTypeAwareJavaElement, JavaPackageElement

@Internal
public abstract class AbstractJavaElement
extends AbstractAnnotationElement

An abstract class for other elements to extend from.

Since:

1.0

Author:

James Kleeh, graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final JavaVisitorContext	visitorContext

Fields inherited from class io.micronaut.inject.ast.annotation.AbstractAnnotationElement

elementAnnotationMetadataFactory, presetAnnotationMetadata

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

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

EMPTY_ELEMENT_ARRAY

Fields inherited from interface io.micronaut.inject.ast.annotation.MutableAnnotationMetadataDelegate

EMPTY

Method Summary

Modifier and Type	Method	Description
protected abstract AbstractJavaElement	copyThis()
protected void	copyValues(AbstractJavaElement element)
boolean	equals(Object o)
Optional<String>	getDocumentation(boolean parse)
Set<ElementModifier>	getModifiers()
@NonNull String	getName()
@NonNull JavaNativeElement	getNativeType()	Returns the native underlying type.
int	hashCode()
boolean	isAbstract()
boolean	isFinal()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
protected final AbstractJavaElement	makeCopy()
protected final @NonNull ClassElement	newClassElement(JavaNativeElement owner, TypeMirror type, Map<String,ClassElement> declaredElementTypeArguments)	Obtain the ClassElement for the given mirror.
protected final @NonNull ClassElement	newClassElement(JavaNativeElement owner, TypeMirror type, Map<String,ClassElement> declaredElementTypeArguments, String doc)	Obtain the ClassElement for the given mirror.
protected final @NonNull ClassElement	newClassElement(TypeMirror type, Map<String,ClassElement> declaredElementTypeArguments)	Obtain the ClassElement for the given mirror.
protected final Map<String,ClassElement>	resolveTypeArguments(ExecutableElement executableElement, Map<String,ClassElement> parentTypeArguments)
protected final Map<String,ClassElement>	resolveTypeArguments(TypeElement typeElement, @Nullable List<? extends TypeMirror> typeMirrorArguments)
String	toString()
Element	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.

Methods inherited from class io.micronaut.inject.ast.annotation.AbstractAnnotationElement

annotate, annotate, annotate, annotate, annotate, getAnnotationMetadata, getAnnotationMetadataToWrite, getElementAnnotationMetadata, getElementAnnotationMetadataFactory, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

Methods inherited from class java.lang.Object

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

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

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

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasEvaluatedExpressions, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

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

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, 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, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, 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.inject.ast.Element

getDescription, getDescription, getDocumentation, getSimpleName, isSynthetic

Field Details

visitorContext

protected final JavaVisitorContext visitorContext

Method Details

copyThis

protected abstract AbstractJavaElement copyThis()

Returns:

copy of this element

copyValues

protected void copyValues(AbstractJavaElement element)

Parameters:

element - the values to be copied to

makeCopy

protected final AbstractJavaElement makeCopy()

withAnnotationMetadata

public Element withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

isPackagePrivate

public boolean isPackagePrivate()

Returns:

True if the element is package private.

getName

@NonNull
public @NonNull String getName()

Returns:

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

getModifiers

public Set<ElementModifier> getModifiers()

Returns:

The ElementModifier types for this class element

getDocumentation

public Optional<String> getDocumentation(boolean parse)

Parameters:

parse - True if the content should be parsed to extract documentation

Returns:

The documentation, if any.

isAbstract

public boolean isAbstract()

Returns:

True if the element is abstract.

isStatic

public boolean isStatic()

Returns:

True if the element is static.

isPublic

public boolean isPublic()

Returns:

True if the element is public.

isPrivate

public boolean isPrivate()

Returns:

True if the element is private.

isFinal

public boolean isFinal()

Returns:

True if the element is final.

isProtected

public boolean isProtected()

Returns:

True if the element is protected.

getNativeType

@NonNull
public @NonNull JavaNativeElement getNativeType()

Description copied from interface: Element

Returns the native underlying type. This API is extended by all inject language implementations. The object returned by this method will be the language native type the information is being retrieved from.

Returns:

The native type

toString

public String toString()

Overrides:

toString in class Object

newClassElement

@NonNull
protected final @NonNull ClassElement newClassElement(JavaNativeElement owner,
 TypeMirror type,
 Map<String,ClassElement> declaredElementTypeArguments)

Obtain the ClassElement for the given mirror.

Parameters:

owner - The owner

type - The type

declaredElementTypeArguments - The type arguments of the declaring element (method, class)

Returns:

The class element

newClassElement

@NonNull
protected final @NonNull ClassElement newClassElement(JavaNativeElement owner,
 TypeMirror type,
 Map<String,ClassElement> declaredElementTypeArguments,
 String doc)

Obtain the ClassElement for the given mirror.

Parameters:

owner - The owner

type - The type

declaredElementTypeArguments - The type arguments of the declaring element (method, class)

doc - The optional documentation

Returns:

The class element

newClassElement

@NonNull
protected final @NonNull ClassElement newClassElement(TypeMirror type,
 Map<String,ClassElement> declaredElementTypeArguments)

Obtain the ClassElement for the given mirror.

Parameters:

type - The type

declaredElementTypeArguments - The type arguments of the declaring element (method, class)

Returns:

The class element

resolveTypeArguments

protected final Map<String,ClassElement> resolveTypeArguments(TypeElement typeElement,
 @Nullable
 @Nullable List<? extends TypeMirror> typeMirrorArguments)

resolveTypeArguments

protected final Map<String,ClassElement> resolveTypeArguments(ExecutableElement executableElement,
 Map<String,ClassElement> parentTypeArguments)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object