org.exolab.javasource
Class JMethodSignature
- JAnnotatedElement
public final class JMethodSignature
A class which holds information about the signtaure of a JMethod. The code in
this package was modelled after the Java Reflection API as much as possible
to reduce the learning curve.
$Revision: 6677 $ $Date: 2004-12-03 11:57:33 -0700 (Fri, 03 Dec 2004) $JMethodSignature(String name) - Creates a new method with the given name and "void" return type.
|
JMethodSignature(String name, JType returnType) - Creates a new method with the given name and return type.
|
JMethodSignature
public JMethodSignature(String name)
Creates a new method with the given name and "void" return type.
name
- The method name. Must not be null.
JMethodSignature
public JMethodSignature(String name,
JType returnType)
Creates a new method with the given name and return type.
name
- The method name. Must not be null.returnType
- The return type of the method. Must not be null.
addException
public void addException(JClass exp)
Adds the given Exception to this JMethodSignature's throws clause.
exp
- The JClass representing the Exception.
addParameter
public void addParameter(JParameter parameter)
Adds the given parameter to this JMethodSignature's list of parameters.
parameter
- The parameter to add to the this JMethodSignature's list
of parameters.
getExceptions
public JClass[] getExceptions()
Returns the exceptions that this JMethodSignature lists in its throws
clause.
- The exceptions that this JMethodSignature lists in its throws
clause.
getJDocComment
public JDocComment getJDocComment()
Returns the JavaDoc comment describing this JMethodSignature.
- The JavaDoc comment describing this JMethodSignature.
getModifiers
public JModifiers getModifiers()
Returns the modifiers for this JMethodSignature.
- The modifiers for this JMethodSignature.
getName
public String getName()
Returns the name of the method.
getParameter
public JParameter getParameter(int index)
Returns the JParameter at the given index.
index
- The index of the JParameter to return.
- The JParameter at the given index.
getParameterClassNames
protected String[] getParameterClassNames()
Returns an array containing the names of the classes of the parameters in
this JMethodSignature. For Arrays, the class name of the object type
stored in the Array is what is returned. Parameters that are primitive
types (and Arrays of primitive types) are not represented in the array of
names returned.
- An array containing the names of the classes of the parameters in
this JMethodSignature.
getParameters
public JParameter[] getParameters()
Returns the set of JParameters in this JMethodSignature.
Note: the array is a copy, the parameters in the array are the
actual references.
- The set of JParameters in this JMethodSignature.
getReturnType
public JType getReturnType()
Returns the JType that represents the return type for the method
signature.
- The JType that represents the return type for the method
signature.
print
public void print(JSourceWriter jsw)
Prints the method signature. A semi-colon (end-of-statement terminator ';')
will not be printed.
jsw
- The JSourceWriter to print to.
print
public void print(JSourceWriter jsw,
boolean printJavaDoc)
Prints the method signature. A semi-colon (end-of-statement terminator ';')
will not be printed.
jsw
- The JSourceWriter to print to.printJavaDoc
- If true, print the JDocComment associated with this
method signature before we print the method signature.
setComment
public void setComment(String comment)
Sets the JavaDoc comment describing this JMethodSignature.
comment
- The JavaDoc comment for this member.
setModifiers
public void setModifiers(JModifiers modifiers)
Sets the JModifiers for this method signature.
modifiers
- The JModifiers for this method signature.
setName
public void setName(String name)
Sets the name of the method.
name
- The name of the method.
toString
public String toString()
Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com