org.codehaus.modello.plugin.java.javasource
public final class JMethodSignature extends Object
Version: $Revision: 555 $ $Date: 2006-01-29 16:38:08 -0500 (Sun, 29 Jan 2006) $
Constructor Summary | |
---|---|
JMethodSignature(String name, JType returnType)
Creates a new method with the given name and return type.
|
Method Summary | |
---|---|
void | addException(JClass exp)
Adds the given Exception to this JMethodSignature's throws clause.
|
void | addParameter(JParameter parameter)
Adds the given parameter to this JMethodSignature's list of
parameters.
|
JClass[] | getExceptions()
Returns the exceptions that this JMethodSignature lists
in it's throws clause.
|
JDocComment | getJDocComment()
Returns the JDocComment describing this JMethodSignature
|
JModifiers | getModifiers()
Returns the modifiers for this JMethodSignature.
|
String | getName()
Returns the name of the method.
|
JParameter | getParameter(int index)
Returns the JParameter at the given index.
|
protected String[] | getParameterClassNames() |
JParameter[] | getParameters()
Returns the set of JParameters for this JMethodSignature
Note: the array is a copy, the params in the array are the actual references. |
JType | getReturnType()
Returns the JType that represents the return type for the
method signature.
|
void | print(JSourceWriter jsw)
Prints the method signature. |
void | print(JSourceWriter jsw, boolean printJavaDoc)
Prints the method signature. |
void | setComment(String comment)
Sets the comment describing this JMethodSignature.
|
void | setModifiers(JModifiers modifiers)
Sets the JModifiers for this method signature.
|
String | toString()
Returns the String representation of this JMethod,
which is the method prototype. |
Parameters: name, the method name. Must not be null. returnType the return type of the method. May be null.
Parameters: exp the JClass representing the Exception
Parameters: parameter the parameter to add to the this Methods list of parameters.
Throws: java.lang.IllegalArgumentException when a parameter already exists for this Method with the same name as the new parameter.
Returns: the exceptions that this JMethodSignature lists in it's throws clause.
Returns: the JDocComment describing this JMethodSignature
Returns: the modifiers for this JMethodSignature.
Returns: the name of the method.
Parameters: index the index of the JParameter to return.
Returns: the JParameter at the given index.
Returns: the set of JParameters for this JMethod
Returns: the JType that represents the return type for the method signature.
Parameters: jsw the JSourceWriter to print to.
Parameters: jsw the JSourceWriter to print to. printJavaDoc a boolean that when true prints the JDocComment associated with this method signature.
Parameters: comment the comment for this member
See Also: JMethodSignature
Parameters: modifiers the JModifiers for this method signature.
Returns: the String representation of this JMethod, which is simply the method prototype