public interface IMethod extends IMember, IAnnotatable
ANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER
Modifier and Type | Method and Description |
---|---|
IMemberValuePair |
getDefaultValue()
Returns a
member value pair representing the default
value of this method if any, or null if this method's parent is
not an annotation type, or else if this method does not have a default value. |
String |
getElementName()
Returns the simple name of this method.
|
String[] |
getExceptionTypes()
Returns the type signatures of the exceptions this method throws,
in the order declared in the source.
|
String |
getKey()
Returns the binding key for this method only if the given method is
resolved . |
int |
getNumberOfParameters()
Returns the number of parameters of this method.
|
String[] |
getParameterNames()
Returns the names of parameters in this method.
|
ILocalVariable[] |
getParameters()
Returns the parameters of this method.
|
String[] |
getParameterTypes()
Returns the type signatures for the parameters of this method.
|
String[] |
getRawParameterNames()
Returns the names of parameters in this method.
|
String |
getReturnType()
Returns the type signature of the return value of this method.
|
String |
getSignature()
Returns the signature of this method.
|
ITypeParameter |
getTypeParameter(String name)
Returns the type parameter declared in this method with the given name.
|
ITypeParameter[] |
getTypeParameters()
Returns the formal type parameters for this method.
|
String[] |
getTypeParameterSignatures()
Deprecated.
Use
getTypeParameters() instead |
boolean |
isConstructor()
Returns whether this method is a constructor.
|
boolean |
isLambdaMethod()
Returns whether this method represents a lambda expression.
|
boolean |
isMainMethod()
Returns whether this method is a main method.
|
boolean |
isResolved()
Returns whether this method represents a resolved method.
|
boolean |
isSimilar(IMethod method)
Returns whether this method is similar to the given method.
|
getCategories, getClassFile, getCompilationUnit, getDeclaringType, getFlags, getJavadocRange, getOccurrenceCount, getType, getTypeRoot, isBinary
exists, getAncestor, getAttachedJavadoc, getCorrespondingResource, getElementType, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnown
getAdapter
exists, getNameRange, getSource, getSourceRange
copy, delete, move, rename
getChildren, hasChildren
getAnnotation, getAnnotations
IMemberValuePair getDefaultValue() throws JavaModelException
member value pair
representing the default
value of this method if any, or null
if this method's parent is
not an annotation type, or else if this method does not have a default value.
Note that IMemberValuePair.getValue()
might return null
.
Please see this method for more details.
null
if noneJavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.String getElementName()
"<init>"
).
For the class initialization methods in binary types, this returns
the special name "<clinit>"
.
This is a handle-only method.getElementName
in interface IJavaElement
String[] getExceptionTypes() throws JavaModelException
For example, a source method declaring "throws IOException"
,
would return the array {"QIOException;"}
.
The type signatures may be either unresolved (for source types)
or resolved (for binary types), and either basic (for basic types)
or rich (for parameterized types). See Signature
for details.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
String[] getTypeParameterSignatures() throws JavaModelException
getTypeParameters()
instead
The formal type parameter signatures may be either unresolved (for source
types) or resolved (for binary types). See Signature
for details.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
ITypeParameter[] getTypeParameters() throws JavaModelException
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.int getNumberOfParameters()
ILocalVariable[] getParameters() throws JavaModelException
An empty array is returned, if the method has no parameters.
For binary types, associated source is used to retrieve the name range
,
source range
and the flags
.
These local variables can be used to retrieve the parameter annotations
.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.String getKey()
resolved
.
A binding key is a key that uniquely identifies this method. It allows access to:
Object.getClass()
If the given method is not resolved, the returned key is simply the java element's key.
IBinding.getKey()
,
BindingKey
,
isResolved()
String[] getParameterNames() throws JavaModelException
For example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}
.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.String[] getParameterTypes()
For example, a source method declared as public void foo(String text, int length)
would return the array {"QString;","I"}
.
The type signatures may be either unresolved (for source types)
or resolved (for binary types), and either basic (for basic types)
or rich (for parameterized types). See Signature
for details.
Signature
String[] getRawParameterNames() throws JavaModelException
For example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}
. For the same method in a
binary, this would return {"arg0", "arg1"}
.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.String getReturnType() throws JavaModelException
For example, a source method declared as public String getName()
would return "QString;"
.
The type signature may be either unresolved (for source types)
or resolved (for binary types), and either basic (for basic types)
or rich (for parameterized types). See Signature
for details.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
String getSignature() throws JavaModelException
For example, a source method declared as public void foo(String text, int length)
would return "(QString;I)V"
.
The type signatures embedded in the method signature may be either unresolved
(for source types) or resolved (for binary types), and either basic (for
basic types) or rich (for parameterized types). See Signature
for
details.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
ITypeParameter getTypeParameter(String name)
name
- the given simple nameboolean isConstructor() throws JavaModelException
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.boolean isMainMethod() throws JavaModelException
"main"
void
static
and public
String[]
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.boolean isLambdaMethod()
boolean isResolved()
boolean isSimilar(IMethod method)
method
- the given methodSignature.getSimpleName(char[])
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.