oracle.javatools.parser.java.v2.model

Interface JavaMethod

All Superinterfaces:

Element, JavaElement, JavaHasAnnotations, JavaHasName, JavaHasType, JavaIsGeneric, JavaMember

All Known Subinterfaces:

SourceMethod

All Known Implementing Classes:

AbstractMethod, CastedMethod, QuickComponent, QuickMethod, WrapperMethod

public interface JavaMethod
extends JavaMember, JavaIsGeneric

The JavaMethod is the compiled representation of a java method or constructor, including the implicit <clinit> method. If you want the syntactic (aka symbolic) representation of a java class, see JavaMethod.

Field Summary

Fields

Modifier and Type	Field and Description
static JavaMethod[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
java.util.Collection<JavaClass>	getDeclaredAnonymousClasses() Get the anonymous classes declared in this method.
java.util.Collection<JavaClass>	getDeclaredLocalClasses() Get the local classes declared in this method.
java.lang.Object	getDefaultValue()
java.lang.String	getDescriptor() Important: This is not the same as getReturnType().getDescriptor() which is synonymous with getReturnType().getDescriptor().
java.util.Collection<JavaType>	getExceptions()
JavaMethod	getMethodErasure() Gets the erasure for this method.
default JavaMethod	getNonParameterizedMethod() Get the JavaMethod as it was declared.
java.util.Collection<JavaMethod>	getOverriddenMethods() According to the JLS, implementing methods are overriding methods where the overriden method is abstract.
java.util.Collection<JavaVariable>	getParameters()
JavaType[]	getParameterTypes()
java.util.Collection<JavaAnnotation>	getReceiverTypeAnnotations() Get the receiver annotations for this method.
JavaType	getReturnType() All constructors have a return type of "void".
java.lang.String	getSignature() Important: This is not the same as getReturnType().getSignature() which is synonymous with getReturnType().getSignature().
SourceMethod	getSourceElement()
java.lang.String	getTypeSignature() Not a JVMS term.
boolean	hasSubsignatureOf(JavaMethod other) True if this method's signature is a subsignature of the other method's signature.
boolean	isConstructor()
boolean	isNative()
boolean	isVarargs()

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaIsGeneric

getActualTypeArguments, getTypeParameter, getTypeParameters, hasActualTypeArguments, hasTypeParameters

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaMember

getOwningClass, getUniqueIdentifier, isAbstract, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasType

getResolvedType, getUnresolvedType

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasName

getName

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasAnnotations

getAnnotation, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, hasAnnotation, hasDeclaredAnnotation

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaElement

getElementKind, getFile, getModifiers, getOwner, isDeprecated, isFinal, isHidden, isMandated, isSourceElement, isSynthetic, printCompiledInfo

Field Detail

EMPTY_ARRAY

static final JavaMethod[] EMPTY_ARRAY

Method Detail

isConstructor

boolean isConstructor()

Returns:

True if this is a constructor, false otherwise.

isVarargs

boolean isVarargs()

Returns:

True if this is a variable argument method, false otherwise.

isNative

boolean isNative()

Returns:

True if this method has been marked as native.

getMethodErasure

JavaMethod getMethodErasure()

Gets the erasure for this method. Here, we define method erasure as the result when all parameterized information is erased. Contrast with type erasure where both generic and parameterized information is erased.

The erasure of a method that is not at all generic is trivially itself. The erasure of a method that is completely unparameterized method is also trivially itself.

Note: Erasure is performed strictly on this method and its owning type and is not performed on any of the contained types. For example, consider the method List<String>.get(int) which has a String return type. The parameterization is from List's E type parameter to String. Erasing the parameterization leaves us with List.get(int) which returns has a E return type.

Returns:

The JavaMethod for this method's erasure.

getReturnType

JavaType getReturnType()

All constructors have a return type of "void".

Returns:

The return type.

getParameters

java.util.Collection<JavaVariable> getParameters()

Returns:

The collection of formal parameters, including the implicit "this$0" parameter if applicable. Returns a collection of JavaVariable's. Note, the "this$0" parameter will be a CompiledTmpVariable which is not compatible with JavaLocalVariable.

getParameterTypes

JavaType[] getParameterTypes()

Returns:

The array of types for the formal parameters, including the implicit "this$0" parameter if applicable. The array is populated with the result of calling getResolvedType() on each parameter returned by getParameters(). Parameter types that fail to resolve will show up as null values in the array.

getExceptions

java.util.Collection<JavaType> getExceptions()

Returns:

The array of checked exceptions. Oddly enough, this includes RuntimeExceptions which, as you know, are ignored by the compiler. (This matches the behavior of java/lang/reflect/Method.) Returns a collection of JavaType's.

getDefaultValue

java.lang.Object getDefaultValue()

Returns:

The default value, if any. Applies only to annotation components.

See Also:

JavaVariable.getConstantValue()

getDescriptor

java.lang.String getDescriptor()

Important: This is not the same as getReturnType().getDescriptor() which is synonymous with getReturnType().getDescriptor(). This returns the method's pre-jdk-1.5 descriptor.

getTypeSignature

java.lang.String getTypeSignature()

Not a JVMS term. Start with the MethodSignature. If there are any actual type arguments, then the type signature of those type arguments (similar to ClassTypeSignature) is appended to the result. Uniquely identifies a method's signature.

getSignature

java.lang.String getSignature()

Important: This is not the same as getReturnType().getSignature() which is synonymous with getReturnType().getSignature(). This returns the method's jdk-1.5 signature.

hasSubsignatureOf

boolean hasSubsignatureOf(JavaMethod other)

True if this method's signature is a subsignature of the other method's signature. For shorthand, we say that "this" method has a subsignature of the "other" method.

getOverriddenMethods

java.util.Collection<JavaMethod> getOverriddenMethods()

According to the JLS, implementing methods are overriding methods where the overriden method is abstract. Order is depth-first, classes before interfaces, left-to-right.

Returns:

The array of methods overriden by this one.

getReceiverTypeAnnotations

java.util.Collection<JavaAnnotation> getReceiverTypeAnnotations()

Get the receiver annotations for this method. In JDK8 and higher the method receiver can be annotated.

Returns:

A Collection of JavaAnnotations which can be empty but will not be null

getDeclaredAnonymousClasses

java.util.Collection<JavaClass> getDeclaredAnonymousClasses()

Get the anonymous classes declared in this method. Local classes are not considered anonymous classes.

Returns:

The anonymous classes in this method which can be an empty Collection but will not be null

getDeclaredLocalClasses

java.util.Collection<JavaClass> getDeclaredLocalClasses()

Get the local classes declared in this method. Anonymous classes are not considered local classes.

Returns:

The local classes in this method which can be an empty Collection but will not be null

getSourceElement

SourceMethod getSourceElement()

Specified by:

getSourceElement in interface JavaElement

Returns:

The corresponding source symbol to this element. Null if there is no corresponding source symbol or if the corresponding source symbol could not be found.

getNonParameterizedMethod

default JavaMethod getNonParameterizedMethod()

Get the JavaMethod as it was declared. For instance, if this JavaMethod is used as this.<String>foo("") and 'foo' is really declared as <T> T foo(T), this method will return <T> T foo(T).

Returns:

The method as it was declared