|
Eclipse JDT Release 3.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Represents a method declaration. The corresponding syntactic units are MethodDeclaration (JLS2 8.4), ConstructorDeclaration (JLS2 8.8), and AbstractMethodDeclaration (JLS2 9.4). A method has no children and its parent is a type. Local classes are considered to be part of the body of a method, not a child. Annotation type members, added in J2SE 1.5, are represented as methods.
This interface is not intended to be implemented by clients.
| Field Summary |
| Fields inherited from interface org.eclipse.jdt.core.jdom.IDOMNode |
COMPILATION_UNIT, FIELD, IMPORT, INITIALIZER, METHOD, PACKAGE, TYPE |
| Method Summary | |
void |
addException(String exceptionType)
Deprecated. Adds the given exception to the end of the list of exceptions this method is declared to throw. |
void |
addParameter(String type,
String name)
Deprecated. Adds the given parameter to the end of the parameter list. |
String |
getBody()
Deprecated. Returns the body of this method. |
String |
getDefault()
Deprecated. Returns the default value expression for an annotation type member. |
String[] |
getExceptions()
Deprecated. Returns the names of the exception types this method throws in the order in which they are declared in the source, or an empty array if this method declares no exception types. |
String |
getName()
Deprecated. The IDOMMethod refinement of this IDOMNode
method returns the name of this method. |
String[] |
getParameterNames()
Deprecated. Returns the names of parameters in this method in the order they are declared, or null if no parameters are declared.
|
String[] |
getParameterTypes()
Deprecated. Returns the type names for the parameters of this method in the order they are declared, or null if no parameters are declared.
|
String |
getReturnType()
Deprecated. Returns the return type name, or null.
|
String[] |
getTypeParameters()
Deprecated. Returns the formal type parameters for this method. |
boolean |
isConstructor()
Deprecated. Returns whether this method is a constructor. |
void |
setBody(String body)
Deprecated. Sets the body of this method. |
void |
setConstructor(boolean b)
Deprecated. Sets whether this method represents a constructor. |
void |
setDefault(String defaultValue)
Deprecated. Sets the default value expression for an annotation type member. |
void |
setExceptions(String[] exceptionTypes)
Deprecated. Sets the names of the exception types this method throws, in the order in which they are declared in the source. |
void |
setName(String name)
Deprecated. The IDOMMethod refinement of this IDOMNode
method sets the name of this method. |
void |
setParameters(String[] types,
String[] names)
Deprecated. Sets the types and names of parameters in this method in the order they are to be declared. |
void |
setReturnType(String type)
Deprecated. Sets the return type name. |
void |
setTypeParameters(String[] typeParameters)
Deprecated. Sets the formal type parameters for this method. |
| Methods inherited from interface org.eclipse.jdt.core.jdom.IDOMMember |
getComment, getFlags, setComment, setFlags |
| Methods inherited from interface org.eclipse.jdt.core.jdom.IDOMNode |
addChild, canHaveChildren, clone, getCharacters, getChild, getChildren, getContents, getFirstChild, getJavaElement, getNextNode, getNodeType, getParent, getPreviousNode, insertSibling, isAllowableChild, isSignatureEqual, remove |
| Method Detail |
public void addException(String exceptionType)
throws IllegalArgumentException
"IOException" or "java.io.IOException".
This is a convenience method for setExceptions.
exceptionType - the exception type
IllegalArgumentException - if null is specifiedsetExceptions(String[])
public void addParameter(String type,
String name)
throws IllegalArgumentException
setParameters.
The syntax for parameter names is defined by Formal Parameters (JLS2 8.4.1).
The syntax for type names is defined by Formal Parameters (JLS2 8.4.1).
Type names must be specified as they would appear in source code. For
example: "File", "java.io.File", or
"int[]".
type - the type namename - the parameter name
IllegalArgumentException - if null is specified for
either the type or the namesetParameters(String[], String[])public String getBody()
null if the method has no body (for
example, for an abstract or native method)public void setDefault(String defaultValue)
defaultValue - the default value expression, or null indicating
the member does not have a default valuepublic String getDefault()
null indicating
the member does not have a default valuepublic String[] getExceptions()
"IOException" or "java.io.IOException".
public String[] getTypeParameters()
Formal type parameters are as they appear in the source
code; for example:
"X extends List<String> & Serializable".
public String getName()
IDOMMethod refinement of this IDOMNode
method returns the name of this method. Returns null for
constructors. The syntax for a method name is defined by Identifier
of MethodDeclarator (JLS2 8.4).
getName in interface IDOMNodenull for constructorspublic String[] getParameterNames()
null if no parameters are declared.
The syntax for parameter names is defined by Formal Parameters (JLS2 8.4.1).
null if no parameters
are declaredpublic String[] getParameterTypes()
null if no parameters are declared.
The syntax for type names is defined by Formal Parameters (JLS2 8.4.1).
Type names must be specified as they would appear in source code. For
example: "File", "java.io.File", or
"int[]".
null if no parameters
are declaredpublic String getReturnType()
null.
Returns null for constructors.
The syntax for return type name corresponds to ReturnType in
MethodDeclaration (JLS2 8.4). Names are returned as they appear in the source
code; for example: "File", "java.io.File",
"int[]", or "void".
public boolean isConstructor()
true for constructors, and false for methodspublic void setBody(String body)
body - the body, or null indicating the method has no body (for
example, for an abstract or native method)public void setConstructor(boolean b)
b - true for constructors, and false for methodspublic void setExceptions(String[] exceptionTypes)
"IOException" or "java.io.IOException".
exceptionTypes - the list of exception typespublic void setTypeParameters(String[] typeParameters)
Formal type parameters are given as they appear in the source
code; for example:
"X extends List<String> & Serializable".
typeParameters - the formal type parameters of this method,
in the order to appear in the source, an empty array if none
public void setName(String name)
throws IllegalArgumentException
IDOMMethod refinement of this IDOMNode
method sets the name of this method. The syntax for a method
name is defined by Identifer of MethodDeclarator (JLS2 8.4).
The name of a constructor is always null and thus it
must not be set.
setName in interface IDOMNodename - the given name
IllegalArgumentException - if null is specified
public void setParameters(String[] types,
String[] names)
throws IllegalArgumentException
types and names are null
this indicates that this method has no parameters.
The syntax for parameter names is defined by Formal Parameters (JLS2 8.4.1).
The syntax for type names is defined by Formal Parameters (JLS2 8.4.1).
Type names must be specified as they would appear in source code. For
example: "File", "java.io.File", or
"int[]".
types - the list of type namesnames - the list of parameter name
IllegalArgumentException - if the number of types and names do not
match, or if either argument is null
public void setReturnType(String type)
throws IllegalArgumentException
"File", "java.io.File",
"int[]", or "void".
type - the return type
IllegalArgumentException - if null is specified
|
Eclipse JDT Release 3.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||