io.micronaut.annotation.processing.visitor

Class JavaMethodElement

java.lang.Object

io.micronaut.annotation.processing.visitor.AbstractJavaElement

io.micronaut.annotation.processing.visitor.JavaMethodElement

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, 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 and Description
protected JavaClassElement	declaringClass
protected ExecutableElement	executableElement
protected JavaVisitorContext	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

Constructor and Description
JavaMethodElement(JavaClassElement declaringClass, ExecutableElement executableElement, AnnotationMetadata annotationMetadata, JavaVisitorContext visitorContext)

Method Summary

Modifier and Type	Method and Description
List<? extends GenericPlaceholderElement>	getDeclaredTypeVariables()
ClassElement	getDeclaringType()
Optional<String>	getDocumentation()
ClassElement	getGenericReturnType() The generic return type of the method.
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.
ClassElement	getReturnType()
ParameterElement[]	getSuspendParameters() If MethodElement.isSuspend() returns true this method exposes the continuation parameter in addition to the other parameters of the method.
ClassElement[]	getThrownTypes() Returns the types declared in the throws declaration of a method.
boolean	isDefault() Is the method a default method on an interfaces.
boolean	isSuspend() Is the method a Kotlin suspend function.
protected io.micronaut.annotation.processing.visitor.JavaParameterElement	newParameterElement(VariableElement variableElement, AnnotationMetadata annotationMetadata) Creates a new parameter element for the given args.
boolean	overrides(MethodElement methodElement) Checks if this method element overrides another.
protected ClassElement	returnType(Map<String,Map<String,TypeMirror>> info) The return type for the given info.
MethodElement	withNewParameters(ParameterElement... newParameters) Takes this method element and transforms into a new method element with the given parameters appended to the existing parameters.

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

annotate, annotate, equals, getAnnotationMetadata, getModifiers, getName, getNativeType, hashCode, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, mirrorToClassElement, mirrorToClassElement, mirrorToClassElement, mirrorToClassElement, parameterizedClassElement, removeAnnotation, removeAnnotationIf, removeStereotype, toString

Methods inherited from class java.lang.Object

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

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

addAssociatedBean, getDescription, hasParameters, of

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

getModifiers, isReflectionRequired, isReflectionRequired

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

annotate, annotate, annotate, annotate, annotate, getDescription, getName, getNativeType, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, 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, getDeclaredAnnotationValuesByName, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

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

getAnnotationMetadata

Field Detail

declaringClass

protected final JavaClassElement declaringClass

executableElement

protected final ExecutableElement executableElement

visitorContext

protected final JavaVisitorContext visitorContext

Constructor Detail

JavaMethodElement

public JavaMethodElement(JavaClassElement declaringClass,
                         ExecutableElement executableElement,
                         AnnotationMetadata annotationMetadata,
                         JavaVisitorContext visitorContext)

Parameters:

declaringClass - The declaring class

executableElement - The ExecutableElement

annotationMetadata - The annotation metadata

visitorContext - The visitor context

Method Detail

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

overrides

public boolean overrides(MethodElement methodElement)

Description copied from interface: MethodElement

Checks if this method element overrides another.

Specified by:

overrides in interface MethodElement

Parameters:

methodElement - Possible overridden method

Returns:

true if this overrides passed method element

getGenericReturnType

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

getDocumentation

public Optional<String> getDocumentation()

Specified by:

getDocumentation in interface Element

Returns:

The documentation, if any.

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

withNewParameters

public MethodElement withNewParameters(ParameterElement... newParameters)

Description copied from interface: MethodElement

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

Specified by:

withNewParameters in interface MethodElement

Parameters:

newParameters - The new parameters

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 io.micronaut.annotation.processing.visitor.JavaParameterElement newParameterElement(@NonNull
                                                                                                       VariableElement variableElement,
                                                                                                       @NonNull
                                                                                                       AnnotationMetadata annotationMetadata)

Creates a new parameter element for the given args.

Parameters:

variableElement - The variable element

annotationMetadata - The annotation metadata

Returns:

The parameter element

getDeclaringType

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

returnType

protected ClassElement returnType(Map<String,Map<String,TypeMirror>> info)

The return type for the given info.

Parameters:

info - The info

Returns:

The return type