public final class JMethodSignature extends Object
Constructor | Description |
---|---|
JMethodSignature(String name,
JType returnType) |
Creates a new method with the given name and return type.
|
Modifier and Type | Method | Description |
---|---|---|
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.
|
public JMethodSignature(String name, JType returnType)
name
- , the method name. Must not be null.returnType
- the return type of the method. May be null.public void addException(JClass exp)
exp
- the JClass representing the Exceptionpublic void addParameter(JParameter parameter) throws IllegalArgumentException
parameter
- the parameter to add to the this Methods
list of parameters.IllegalArgumentException
- when a parameter already
exists for this Method with the same name as the new
parameter.public JClass[] getExceptions()
public JDocComment getJDocComment()
public JModifiers getModifiers()
public String getName()
public JParameter getParameter(int index)
index
- the index of the JParameter to return.public JParameter[] getParameters()
public JType getReturnType()
public void setComment(String comment)
comment
- the comment for this membergetJDocComment()
public void setModifiers(JModifiers modifiers)
modifiers
- the JModifiers for this method signature.public void print(JSourceWriter jsw)
jsw
- the JSourceWriter to print to.public void print(JSourceWriter jsw, boolean printJavaDoc)
jsw
- the JSourceWriter to print to.printJavaDoc
- a boolean that when true prints the JDocComment
associated with this method signature.public String toString()
protected String[] getParameterClassNames()
Copyright © 2001–2018 Codehaus Plexus. All rights reserved.