oracle.javatools.parser.java.v2.model

Interface SourceMethod

All Superinterfaces:

Element, JavaElement, JavaHasAnnotations, JavaHasName, JavaHasType, JavaIsGeneric, JavaMember, JavaMethod, SourceElement, SourceHasBlock, SourceHasDocComment, SourceHasModifiers, SourceHasName, SourceMember

public interface SourceMethod
extends SourceMember, SourceHasName, SourceHasBlock, JavaMethod

A SourceMethod is the syntactic (aka symbolic) representation of a java method or constructor declaration.

Field Summary

Fields

Modifier and Type	Field and Description
static SourceMethod[]	EMPTY_ARRAY
static int	PRINT_DECLARATION Constant that can be used as the format argument in calls to SourceMethod.print(int) or SourceMethod.print(PrintWriter, int).
static int	PRINT_SIGNATURE Constant that can be used as the format argument in calls to SourceMethod.print(int) or SourceMethod.print(PrintWriter, int).

Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT

Method Summary

Modifier and Type	Method and Description
SourceFormalParameterList	getFormalParameterList() Gets the formal parameter list object.
java.util.List<SourceClass>	getSourceAnonymousClasses() Gets the list of anonymous class declarations enclosed by this method, but not enclosed by any inner class of this method.
java.util.List<SourceTypeReference>	getSourceExceptions() Gets the list of source exception types.
java.util.List<SourceClass>	getSourceLocalClasses() Gets the list of local class declarations enclosed by this method, but not enclosed by any inner class of this method.
java.util.List<SourceVariable>	getSourceParameters() Gets the list of source parameters.
java.util.List<SourceAnnotation>	getSourceReceiverAnnotations() Get the receiver annotations for this method.
SourceTypeReference	getSourceReturnType() Gets the source return type.
java.util.List<SourceTypeParameter>	getSourceTypeParameters() Gets the declared type parameters on this method.
SourceThrowsClause	getThrowsClause() Gets the throws clause object.
boolean	isConstructor() True if this is a constructor.
boolean	isVarargs() Tests if this method is modified by ACC_VARARGS.
void	setSourceReturnType(SourceTypeReference type) Attempts to set the return type of this method.

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

getEnclosingClass, hasDeprecatedTag, hasHiddenTag

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

addModifiers, getModifiers, getSourceAnnotations, hasSourceAnnotation, isValidModifiers, removeModifiers, setModifiers

Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceHasDocComment

getDocComment, setDocComment

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

addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, createContext, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getContext, getEndOffset, getFirstToken, getJdkVersion, getLastToken, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingAfter, getSiblingBefore, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, getTokens, getTokens, hasErrors, print, print, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf

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

getName, getNameElement, setName, setNameElement

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

getBlock, setBlock

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

getDeclaredAnonymousClasses, getDeclaredLocalClasses, getDefaultValue, getDescriptor, getExceptions, getMethodErasure, getNonParameterizedMethod, getOverriddenMethods, getParameters, getParameterTypes, getReceiverTypeAnnotations, getReturnType, getSignature, getSourceElement, getTypeSignature, hasSubsignatureOf, isNative

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, isSourceElement, isSynthetic, printCompiledInfo

Field Detail

EMPTY_ARRAY

static final SourceMethod[] EMPTY_ARRAY

PRINT_SIGNATURE

static final int PRINT_SIGNATURE

Constant that can be used as the format argument in calls to SourceMethod.print(int) or SourceMethod.print(PrintWriter, int). Prints the method name and the parameter types.

See Also:

Constant Field Values

PRINT_DECLARATION

static final int PRINT_DECLARATION

Constant that can be used as the format argument in calls to SourceMethod.print(int) or SourceMethod.print(PrintWriter, int). Prints the modifiers, type parameters, return type, method name, the parameter names and types, and the throws types.

See Also:

Constant Field Values

Method Detail

isConstructor

boolean isConstructor()

True if this is a constructor.

Specified by:

isConstructor in interface JavaMethod

Returns:

True if this is a constructor. False otherwise.

isVarargs

boolean isVarargs()

Tests if this method is modified by ACC_VARARGS.

Specified by:

isVarargs in interface JavaMethod

Returns:

True if this is a variable arguments method. False otherwise.

getSourceTypeParameters

java.util.List<SourceTypeParameter> getSourceTypeParameters()

Gets the declared type parameters on this method. For methods, syntax is "javadoc mods <ty_params> return_ty method...". Constructors may not declare type parameters.

Returns:

The array of type parameters. May be zero-length. Returns a collection of SourceTypeParameter's.

getSourceReturnType

SourceTypeReference getSourceReturnType()

Gets the source return type.

Returns:

The SourceTypeReference for the return type of this method. Null if this is a constructor.

setSourceReturnType

void setSourceReturnType(SourceTypeReference type)

Attempts to set the return type of this method.

Throws:

java.lang.UnsupportedOperationException - if this is a constructor.

getSourceParameters

java.util.List<SourceVariable> getSourceParameters()

Gets the list of source parameters.

Returns:

The array of SourceVariables for all the parameters in its formal parameter list. May be zero-length. Includes the synthetic "this$0" parameter where applicable. Returns a collection of SourceVariable's.

getSourceExceptions

java.util.List<SourceTypeReference> getSourceExceptions()

Gets the list of source exception types.

Returns:

The array of SourceTypeReferences for all the exceptions thrown by this method. May be zero-length. Returns a collection of SourceTypeReference's.

getFormalParameterList

SourceFormalParameterList getFormalParameterList()

Gets the formal parameter list object.

Returns:

The SourceFormalParameterList that wraps the formal parameters.

getThrowsClause

SourceThrowsClause getThrowsClause()

Gets the throws clause object.

Returns:

The SourceThrowsClause that wraps the thrown exception types.

getSourceAnonymousClasses

java.util.List<SourceClass> getSourceAnonymousClasses()

Gets the list of anonymous class declarations enclosed by this method, but not enclosed by any inner class of this method. The list does not include member or local classes. Anonymous classes cannot be added or removed from the list. To remove an anonymous class, call 'removeSelf' on the class object, or remove it from its parent. To add an anonymous class, create the statement that uses the anonymous class, and add that statement to a SourceBlock.

Returns:

All source-model anonymous classes of this method. Returns a read-only collection of SourceClass's.

getSourceLocalClasses

java.util.List<SourceClass> getSourceLocalClasses()

Gets the list of local class declarations enclosed by this method, but not enclosed by any inner class of this method. The list does not include member or anonymous classes. Local classes cannot be added or removed from the list. To remove a local class, call 'removeSelf' on the class object, or remove it from its parent. To add a local class, add it to a SourceBlock.

Returns:

All source-model local classes of this method. Returns a read-only collection of SourceClass's.

getSourceReceiverAnnotations

java.util.List<SourceAnnotation> getSourceReceiverAnnotations()

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

Returns:

A list of SourceAnnotations which can be empty but will not be null