Package io.micronaut.annotation.processing.visitor

Class JavaMethodElement

java.lang.Object

io.micronaut.inject.ast.annotation.AbstractAnnotationElement

io.micronaut.annotation.processing.visitor.AbstractJavaElement

io.micronaut.annotation.processing.visitor.JavaMethodElement

All Implemented Interfaces:

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

@Internal
public class JavaMethodElement
extends AbstractJavaElement
implements MethodElement

A method element returning data from a ExecutableElement.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
protected final ExecutableElement	executableElement
protected final JavaClassElement	owningType

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

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

Constructor Summary

Constructors

Constructor	Description
JavaMethodElement(JavaClassElement owningType, JavaNativeElement.Method nativeElement, ElementAnnotationMetadataFactory annotationMetadataFactory, JavaVisitorContext visitorContext)

Method Summary

Modifier and Type	Method	Description
protected AbstractJavaElement	copyThis()
protected void	copyValues(AbstractJavaElement element)
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()
JavaClassElement	getDeclaringType()
@NonNull ClassElement	getGenericReturnType()	The generic return type of the method.
ElementAnnotationMetadata	getMethodAnnotationMetadata()	Returns the method annotations.
JavaNativeElement.Method	getNativeType()	Returns the native underlying type.
ClassElement	getOwningType()	The owing type is the type that owns this element.
ParameterElement[]	getParameters()
Optional<ClassElement>	getReceiverType()	Returns the receiver type of this executable, or empty if the method has no receiver type.
@NonNull ClassElement	getReturnType()
ParameterElement[]	getSuspendParameters()	If MethodElement.isSuspend() returns true this method exposes the continuation parameter in addition to the other parameters of the method.
@NonNull 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	hides(MemberElement hidden)	Checks if this member element hides another.
boolean	isDefault()	Is the method a default method on an interfaces.
boolean	isSuspend()	Is the method a Kotlin suspend function.
boolean	isVarArgs()	If method has varargs parameter.
protected @NonNull io.micronaut.annotation.processing.visitor.JavaParameterElement	newParameterElement(@NonNull MethodElement methodElement, @NonNull VariableElement variableElement)	Creates a new parameter element for the given args.
boolean	overrides(MethodElement overridden)	Checks if this method element overrides another.
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... parameters)	Takes this method element and transforms into a new method element with the given parameters.

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

equals, getDocumentation, getModifiers, getName, hashCode, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, makeCopy, newClassElement, newClassElement, resolveTypeArguments, resolveTypeArguments, toString

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, getName, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

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

getModifiers, isAccessible, isAccessible, isReflectionRequired, isReflectionRequired

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

addAssociatedBean, getDescription, hasParameters, withNewParameters

Field Details

owningType

protected final JavaClassElement owningType

executableElement

protected final ExecutableElement executableElement

Constructor Details

JavaMethodElement

public JavaMethodElement(JavaClassElement owningType,
 JavaNativeElement.Method nativeElement,
 ElementAnnotationMetadataFactory annotationMetadataFactory,
 JavaVisitorContext visitorContext)

Parameters:

owningType - The declaring class

nativeElement - The native element

annotationMetadataFactory - The annotation metadata factory

visitorContext - The visitor context

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

getNativeType

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

Overrides:

getNativeType in class AbstractJavaElement

Returns:

The native type

copyThis

protected AbstractJavaElement copyThis()

Specified by:

copyThis in class AbstractJavaElement

Returns:

copy of this element

copyValues

protected void copyValues(AbstractJavaElement element)

Overrides:

copyValues in class AbstractJavaElement

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 AbstractJavaElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

withParameters

public MethodElement withParameters(ParameterElement... parameters)

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:

parameters - The new parameters

Returns:

A new method element

getReceiverType

public Optional<ClassElement> getReceiverType()

Description copied from interface: MethodElement

Returns the receiver type of this executable, or empty if the method has no receiver type.

A MethodElement which is an instance method, or a constructor of an inner class, has a receiver type derived from the declaring type.

A MethodElement which is a static method, or a constructor of a non-inner class, or an initializer (static or instance), has no receiver type.

Specified by:

getReceiverType in interface MethodElement

Returns:

The receiver type for the method if one exists.

getThrownTypes

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

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.

isVarArgs

public boolean isVarArgs()

Description copied from interface: MethodElement

If method has varargs parameter.

Specified by:

isVarArgs in interface MethodElement

Returns:

True if it does

overrides

public boolean overrides(MethodElement overridden)

Description copied from interface: MethodElement

Checks if this method element overrides another.

Specified by:

overrides in interface MethodElement

Parameters:

overridden - Possible overridden method

Returns:

true if this overrides passed method element

hides

public boolean hides(MemberElement hidden)

Description copied from interface: MemberElement

Checks if this member element hides another.

Specified by:

hides in interface MemberElement

Specified by:

hides in interface MethodElement

Parameters:

hidden - The possibly hidden element

Returns:

true if this member element hides passed field 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

getDeclaredTypeVariables

public List<? extends GenericPlaceholderElement> getDeclaredTypeVariables()

Specified by:

getDeclaredTypeVariables in interface MethodElement

Returns:

The type arguments declared on this method.

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

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

isSuspend

public boolean isSuspend()

Description copied from interface: MethodElement

Is the method a Kotlin suspend function.

Specified by:

isSuspend in interface MethodElement

Returns:

True if it is.

getParameters

public ParameterElement[] getParameters()

Specified by:

getParameters in interface MethodElement

Returns:

The method parameters

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

getSuspendParameters

public ParameterElement[] getSuspendParameters()

Description copied from interface: MethodElement

If MethodElement.isSuspend() returns true this method exposes the continuation parameter in addition to the other parameters of the method.

Specified by:

getSuspendParameters in interface MethodElement

Returns:

The suspend parameters

newParameterElement

@NonNull
protected @NonNull io.micronaut.annotation.processing.visitor.JavaParameterElement newParameterElement(@NonNull
 @NonNull MethodElement methodElement,
 @NonNull
 @NonNull VariableElement variableElement)

Creates a new parameter element for the given args.

Parameters:

methodElement - The method element

variableElement - The variable element

Returns:

The parameter element

getDeclaringType

public JavaClassElement getDeclaringType()

Specified by:

getDeclaringType in interface MemberElement

Returns:

The declaring type of the element.

getOwningType

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