| org.eclipse.jdt.core.IMethod
All known Subclasses: org.eclipse.jdt.internal.core.SourceMethod, org.eclipse.jdt.internal.core.BinaryMethod,
| IMethod | | public interface IMethod extends IMember(Code) | | Represents a method (or constructor) declared in a type.
This interface is not intended to be implemented by clients.
|
| Method Summary | |
| 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. | | int | getNumberOfParameters()
Returns the number of parameters of this method. | | String[] | getParameterNames()
Returns the names of parameters in this method.
For binary types, associated source or attached Javadoc are used to retrieve the names.
If none can be retrieved, then these names are invented as "arg"+i, where i starts at 0.
Returns an empty array if this method has no parameters.
For example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. | | String[] | getParameterTypes()
Returns the type signatures for the parameters of this method.
Returns an empty array if this method has no parameters.
This is a handle-only method.
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). | | String[] | getRawParameterNames()
Returns the names of parameters in this method.
For binary types, these names are invented as "arg"+i, where i starts at 0
(even if source is associated with the binary or if Javdoc is attached to the binary).
Returns an empty array if this method has no parameters.
For example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}. | | String | getReturnType()
Returns the type signature of the return value of this method.
For constructors, this returns the signature for void.
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). | | String | getSignature()
Returns the signature of this method. | | ITypeParameter | getTypeParameter(String name)
Returns the type parameter declared in this method with the given name.
This is a handle-only method. | | String[] | getTypeParameterSignatures()
Returns the formal type parameter signatures for this method.
Returns an empty array if this method has no formal type parameters.
The formal type parameter signatures may be either unresolved (for source
types) or resolved (for binary types). | | ITypeParameter[] | getTypeParameters()
Returns the formal type parameters for this method.
Returns an empty array if this method has no formal type parameters.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. | | boolean | isConstructor()
Returns whether this method is a constructor.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. | | 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. |
| getElementName | | String getElementName()(Code) | | Returns the simple name of this method.
For a constructor, this returns the simple name of the declaring type.
Note: This holds whether the constructor appears in a source or binary type
(even though class files internally define constructor names to be "<init>").
For the class initialization methods in binary types, this returns
the special name "<clinit>".
This is a handle-only method.
the simple name of this method |
| getExceptionTypes | | String[] getExceptionTypes() throws JavaModelException(Code) | | Returns the type signatures of the exceptions this method throws,
in the order declared in the source. Returns an empty array
if this method throws no exceptions.
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.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the type signatures of the exceptions this method throws,in the order declared in the source, an empty array if this method throws no exceptions
See Also: Signature |
| getNumberOfParameters | | int getNumberOfParameters()(Code) | | Returns the number of parameters of this method.
This is a handle-only method.
the number of parameters of this method |
| getParameterNames | | String[] getParameterNames() throws JavaModelException(Code) | | Returns the names of parameters in this method.
For binary types, associated source or attached Javadoc are used to retrieve the names.
If none can be retrieved, then these names are invented as "arg"+i, where i starts at 0.
Returns an empty array if this method has no parameters.
For example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the names of parameters in this method, an empty array if this method has no parameters |
| getParameterTypes | | String[] getParameterTypes()(Code) | | Returns the type signatures for the parameters of this method.
Returns an empty array if this method has no parameters.
This is a handle-only method.
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.
the type signatures for the parameters of this method, an empty array if this method has no parameters
See Also: Signature |
| getRawParameterNames | | String[] getRawParameterNames() throws JavaModelException(Code) | | Returns the names of parameters in this method.
For binary types, these names are invented as "arg"+i, where i starts at 0
(even if source is associated with the binary or if Javdoc is attached to the binary).
Returns an empty array if this method has no parameters.
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"}.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the names of parameters in this method, an empty array if this method has no parameters
since:
3.2 |
| getReturnType | | String getReturnType() throws JavaModelException(Code) | | Returns the type signature of the return value of this method.
For constructors, this returns the signature for void.
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.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the type signature of the return value of this method, void for constructors
See Also: Signature |
| getSignature | | String getSignature() throws JavaModelException(Code) | | Returns the signature of this method. This includes the signatures for the
parameter types and return type, but does not include the method name,
exception types, or type parameters.
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.
the signature of this method
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource.
See Also: Signature |
| getTypeParameter | | ITypeParameter getTypeParameter(String name)(Code) | | Returns the type parameter declared in this method with the given name.
This is a handle-only method. The type parameter may or may not exist.
Parameters:
name - the given simple name the type parameter declared in this method with the given name
since:
3.1 |
| getTypeParameterSignatures | | String[] getTypeParameterSignatures() throws JavaModelException(Code) | | Returns the formal type parameter signatures for this method.
Returns an empty array if this method has no formal type parameters.
The formal type parameter signatures may be either unresolved (for source
types) or resolved (for binary types). See
Signature for details.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the formal type parameter signatures of this method,in the order declared in the source, an empty array if none
See Also: Signature
since:
3.0IMethod.getTypeParameters() |
| getTypeParameters | | ITypeParameter[] getTypeParameters() throws JavaModelException(Code) | | Returns the formal type parameters for this method.
Returns an empty array if this method has no formal type parameters.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. the formal type parameters of this method,in the order declared in the source, an empty array if none
since:
3.1 |
| isConstructor | | boolean isConstructor() throws JavaModelException(Code) | | Returns whether this method is a constructor.
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource. true if this method is a constructor, false otherwise |
| isMainMethod | | boolean isMainMethod() throws JavaModelException(Code) | | Returns whether this method is a main method.
It is a main method if:
- its name is equal to
"main"
- its return type is
void
- it is
static and public
- it defines one parameter whose type's simple name is
String[]
exception:
JavaModelException - if this element does not exist or if anexception occurs while accessing its corresponding resource.
since:
2.0 true if this method is a main method, false otherwise |
| isResolved | | boolean isResolved()(Code) | | Returns whether this method represents a resolved method.
If a method is resoved, its key contains resolved information.
whether this method represents a resolved method.
since:
3.1 |
| isSimilar | | boolean isSimilar(IMethod method)(Code) | | Returns whether this method is similar to the given method.
Two methods are similar if:
- their element names are equal
- they have the same number of parameters
- the simple names of their parameter types are equal
This is a handle-only method.
Parameters:
method - the given method true if this method is similar to the given method.
See Also: Signature.getSimpleName(char[])
since:
2.0 |
|
|