Package io.micronaut.ast.groovy.visitor

Class GroovyMethodElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.ast.groovy.visitor.AbstractGroovyElement

io.micronaut.ast.groovy.visitor.GroovyMethodElement

All Implemented Interfaces:

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

Direct Known Subclasses:

GroovyConstructorElement

@Internal
public class GroovyMethodElement
extends AbstractGroovyElement
implements MethodElement

A method element returning data from a MethodNode.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
protected ParameterElement[]	parameters

Fields inherited from class io.micronaut.ast.groovy.visitor.AbstractGroovyElement

compilationUnit, sourceUnit, 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 AbstractGroovyElement	copyConstructor()	Constructs this element by invoking the constructor.
protected void	copyValues(AbstractGroovyElement element)	Copies additional values after the element was constructed by AbstractGroovyElement.copyConstructor().
AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
protected MutableAnnotationMetadataDelegate<?>	getAnnotationMetadataToWrite()	Get annotation metadata to add or remove annotations.
Map<String,ClassElement>	getDeclaredTypeArguments()	The declared type arguments for this method element.
List<? extends GenericPlaceholderElement>	getDeclaredTypeVariables()
ClassElement	getDeclaringType()
@NonNull ClassElement	getGenericReturnType()	The generic return type of the method.
ElementAnnotationMetadata	getMethodAnnotationMetadata()	Returns the method annotations.
Set<ElementModifier>	getModifiers()
String	getName()
Collection<MethodElement>	getOverriddenMethods()	Get overridden methods by this method.
GroovyClassElement	getOwningType()	The owing type is the type that owns this element.
ParameterElement[]	getParameters()
@NonNull ClassElement	getReturnType()
ClassElement[]	getThrownTypes()	Returns the types declared in the throws declaration of a method.
Map<String,ClassElement>	getTypeArguments()	The type arguments for this method element.
boolean	isAbstract()
boolean	isDefault()	Is the method a default method on an interfaces.
boolean	isFinal()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
String	toString()
MethodElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.
MethodElement	withNewOwningType(ClassElement owningType)	Returns a new method with a new owning type.
MethodElement	withParameters(ParameterElement... newParameters)	Takes this method element and transforms into a new method element with the given parameters.

Methods inherited from class io.micronaut.ast.groovy.visitor.AbstractGroovyElement

copy, equals, getDocumentation, getNativeType, hashCode, newClassElement, newClassElement, newClassElement, resolveClassTypeArguments, resolveMethodTypeArguments, resolveModifiers, resolveModifiers, resolveModifiers, resolveTypeArgumentsToObject

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

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

annotate, annotate, annotate, annotate, annotate, getDescription, getDocumentation, getNativeType, getSimpleName, isSynthetic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

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

isAccessible, isAccessible, isAccessible, isReflectionRequired, isReflectionRequired

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

addAssociatedBean, getDescription, getReceiverType, getSuspendParameters, hasParameters, hides, hides, isSubSignature, isSuspend, isVarArgs, overrides, withNewParameters

Field Details

parameters

protected ParameterElement[] parameters

Method Details

getAnnotationMetadataToWrite

protected MutableAnnotationMetadataDelegate<?> getAnnotationMetadataToWrite()

Description copied from class: AbstractAnnotationElement

Get annotation metadata to add or remove annotations.

Overrides:

getAnnotationMetadataToWrite in class AbstractAnnotationElement

Returns:

The annotation metadata to write

getMethodAnnotationMetadata

public ElementAnnotationMetadata getMethodAnnotationMetadata()

Description copied from interface: MethodElement

Returns the method annotations. The method will only return annotations defined on a method or inherited from the super methods, while AnnotationMetadataProvider.getAnnotationMetadata() for a method combines the class and the method annotations. NOTE: For a constructor AnnotationMetadataProvider.getAnnotationMetadata() will not combine the class annotations.

Specified by:

getMethodAnnotationMetadata in interface MethodElement

Returns:

The method annotation metadata

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 AbstractAnnotationElement

Returns:

The AnnotationMetadata

copyConstructor

protected AbstractGroovyElement copyConstructor()

Description copied from class: AbstractGroovyElement

Constructs this element by invoking the constructor.

Specified by:

copyConstructor in class AbstractGroovyElement

Returns:

the copy

copyValues

protected void copyValues(AbstractGroovyElement element)

Description copied from class: AbstractGroovyElement

Copies additional values after the element was constructed by AbstractGroovyElement.copyConstructor().

Overrides:

copyValues in class AbstractGroovyElement

Parameters:

element - the values to be copied to

withAnnotationMetadata

public MethodElement withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Specified by:

withAnnotationMetadata in interface Element

Specified by:

withAnnotationMetadata in interface MemberElement

Specified by:

withAnnotationMetadata in interface MethodElement

Overrides:

withAnnotationMetadata in class AbstractGroovyElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

withParameters

public MethodElement withParameters(ParameterElement... newParameters)

Description copied from interface: MethodElement

Takes this method element and transforms into a new method element with the given parameters.

Specified by:

withParameters in interface MethodElement

Parameters:

newParameters - The new parameters

Returns:

A new method element

withNewOwningType

public MethodElement withNewOwningType(ClassElement owningType)

Description copied from interface: MethodElement

Returns a new method with a new owning type.

Specified by:

withNewOwningType in interface MethodElement

Parameters:

owningType - The owning type.

Returns:

A new method element

getThrownTypes

public ClassElement[] getThrownTypes()

Description copied from interface: MethodElement

Returns the types declared in the throws declaration of a method.

Specified by:

getThrownTypes in interface MethodElement

Returns:

The throws types, if any. Never null.

getModifiers

public Set<ElementModifier> getModifiers()

Specified by:

getModifiers in interface Element

Specified by:

getModifiers in interface MemberElement

Returns:

The ElementModifier types for this class element

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Specified by:

getName in interface Element

Specified by:

getName in interface Named

Returns:

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

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.

isPackagePrivate

public boolean isPackagePrivate()

Specified by:

isPackagePrivate in interface Element

Overrides:

isPackagePrivate in class AbstractGroovyElement

Returns:

True if the element is package 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.

isDefault

public boolean isDefault()

Description copied from interface: MethodElement

Is the method a default method on an interfaces.

Specified by:

isDefault in interface MethodElement

Returns:

True if it is.

getDeclaredTypeArguments

public Map<String,ClassElement> getDeclaredTypeArguments()

Description copied from interface: MethodElement

The declared type arguments for this method element.

Specified by:

getDeclaredTypeArguments in interface MethodElement

Returns:

The declared type arguments for this method element

getTypeArguments

public Map<String,ClassElement> getTypeArguments()

Description copied from interface: MethodElement

The type arguments for this method element. The type arguments should include the type arguments added to the method plus the type arguments of the declaring class.

Specified by:

getTypeArguments in interface MethodElement

Returns:

The type arguments for this method element

getGenericReturnType

@NonNull
public @NonNull ClassElement getGenericReturnType()

Description copied from interface: MethodElement

The generic return type of the method.

Specified by:

getGenericReturnType in interface MethodElement

Returns:

The return type of the method

getReturnType

@NonNull
public @NonNull ClassElement getReturnType()

Specified by:

getReturnType in interface MethodElement

Returns:

The return type of the method

getParameters

public ParameterElement[] getParameters()

Specified by:

getParameters in interface MethodElement

Returns:

The method parameters

getDeclaringType

public ClassElement getDeclaringType()

Specified by:

getDeclaringType in interface MemberElement

Returns:

The declaring type of the element.

getOwningType

public GroovyClassElement getOwningType()

Description copied from interface: MemberElement

The owing type is the type that owns this element. This can differ from MemberElement.getDeclaringType() in the case of inheritance since this method will return the subclass that owners the inherited member, whilst MemberElement.getDeclaringType() will return the super class that declares the type.

Specified by:

getOwningType in interface MemberElement

Returns:

The owning type.

getDeclaredTypeVariables

public List<? extends GenericPlaceholderElement> getDeclaredTypeVariables()

Specified by:

getDeclaredTypeVariables in interface MethodElement

Returns:

The type arguments declared on this method.

getOverriddenMethods

public Collection<MethodElement> getOverriddenMethods()

Description copied from interface: MethodElement

Get overridden methods by this method.

Specified by:

getOverriddenMethods in interface MethodElement

Returns:

The overridden method by this method.