io.micronaut.ast.groovy.visitor

Class AbstractGroovyElement

java.lang.Object

io.micronaut.ast.groovy.visitor.AbstractGroovyElement

All Implemented Interfaces:

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

Direct Known Subclasses:

GroovyClassElement, GroovyEnumConstantElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement

public abstract class AbstractGroovyElement
extends Object
implements AnnotationMetadataDelegate, Element

Abstract Groovy element.

Since:

1.1

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.groovy.control.CompilationUnit	compilationUnit
protected org.codehaus.groovy.control.SourceUnit	sourceUnit
protected GroovyVisitorContext	visitorContext

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGroovyElement(GroovyVisitorContext visitorContext, org.codehaus.groovy.ast.AnnotatedNode annotatedNode, AnnotationMetadata annotationMetadata) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected Map<String,org.codehaus.groovy.ast.ClassNode>	alignNewGenericsInfo(org.codehaus.groovy.ast.GenericsType[] genericsTypes, org.codehaus.groovy.ast.GenericsType[] redirectTypes, Map<String,org.codehaus.groovy.ast.ClassNode> genericsSpec) Align the given generic types.
<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()
protected ClassElement	getGenericElement(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.ClassNode type, ClassElement rawElement, Map<String,org.codehaus.groovy.ast.ClassNode> genericsSpec) Get a generic element for the given element and data.
int	hashCode()
boolean	isPackagePrivate()
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.
protected AnnotationMetadata	resolveAnnotationMetadata(org.codehaus.groovy.ast.ClassNode type) Resolves the annotation metadata for the given type.
protected Set<ElementModifier>	resolveModifiers(org.codehaus.groovy.ast.ClassNode classNode) Resolve modifiers for a class node.
protected Set<ElementModifier>	resolveModifiers(org.codehaus.groovy.ast.FieldNode fieldNode) Resolve modifiers for a field node.
protected Set<ElementModifier>	resolveModifiers(org.codehaus.groovy.ast.MethodNode methodNode) Resolve modifiers for a method node.

Methods inherited from class java.lang.Object

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

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

annotate, annotate, annotate, getDescription, getDescription, getModifiers, getName, getNativeType, getSimpleName, isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic, 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

Field Detail

sourceUnit

protected final org.codehaus.groovy.control.SourceUnit sourceUnit

compilationUnit

protected final org.codehaus.groovy.control.CompilationUnit compilationUnit

visitorContext

protected final GroovyVisitorContext visitorContext

Constructor Detail

AbstractGroovyElement

protected AbstractGroovyElement(GroovyVisitorContext visitorContext,
                                org.codehaus.groovy.ast.AnnotatedNode annotatedNode,
                                AnnotationMetadata annotationMetadata)

Default constructor.

Parameters:

visitorContext - The groovy visitor context

annotatedNode - The annotated node

annotationMetadata - The annotation metadata

Method Detail

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

isPackagePrivate

public boolean isPackagePrivate()

Specified by:

isPackagePrivate in interface Element

Returns:

True if the element is package private.

annotate

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

alignNewGenericsInfo

protected Map<String,org.codehaus.groovy.ast.ClassNode> alignNewGenericsInfo(@NonNull
                                                                             org.codehaus.groovy.ast.GenericsType[] genericsTypes,
                                                                             @NonNull
                                                                             org.codehaus.groovy.ast.GenericsType[] redirectTypes,
                                                                             @NonNull
                                                                             Map<String,org.codehaus.groovy.ast.ClassNode> genericsSpec)

Align the given generic types.

Parameters:

genericsTypes - The generic types

redirectTypes - The redirect types

genericsSpec - The current generics spec

Returns:

The new generic spec

getGenericElement

@NonNull
protected ClassElement getGenericElement(@NonNull
                                                  org.codehaus.groovy.control.SourceUnit sourceUnit,
                                                  @NonNull
                                                  org.codehaus.groovy.ast.ClassNode type,
                                                  @NonNull
                                                  ClassElement rawElement,
                                                  @NonNull
                                                  Map<String,org.codehaus.groovy.ast.ClassNode> genericsSpec)

Get a generic element for the given element and data.

Parameters:

sourceUnit - The source unit

type - The type

rawElement - A raw element to fall back to

genericsSpec - The generics spec

Returns:

The element, never null.

getDocumentation

public Optional<String> getDocumentation()

Specified by:

getDocumentation in interface Element

Returns:

The documentation, if any.

resolveAnnotationMetadata

@NonNull
protected AnnotationMetadata resolveAnnotationMetadata(@NonNull
                                                                org.codehaus.groovy.ast.ClassNode type)

Resolves the annotation metadata for the given type.

Parameters:

type - The type

Returns:

The annotation metadata

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

resolveModifiers

protected Set<ElementModifier> resolveModifiers(org.codehaus.groovy.ast.MethodNode methodNode)

Resolve modifiers for a method node.

Parameters:

methodNode - The method node

Returns:

The modifiers

resolveModifiers

protected Set<ElementModifier> resolveModifiers(org.codehaus.groovy.ast.FieldNode fieldNode)

Resolve modifiers for a field node.

Parameters:

fieldNode - The field node

Returns:

The modifiers

resolveModifiers

protected Set<ElementModifier> resolveModifiers(org.codehaus.groovy.ast.ClassNode classNode)

Resolve modifiers for a class node.

Parameters:

classNode - The class node

Returns:

The modifiers