Package org.codehaus.modello.plugin.java.javasource

Class JMethodSignature

java.lang.Object

org.codehaus.modello.plugin.java.javasource.JMethodSignature

public final class JMethodSignature
extends java.lang.Object

A class which holds information about the signature of a JMethod. The code in this package was modelled after the Java Reflection API as much as possible to reduce the learning curve.

Author:

Keith Visco

Constructor Summary

Constructors

Constructor	Description
JMethodSignature(java.lang.String name, JType returnType)	Creates a new method with the given name and return type.

Method Summary

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.
java.lang.String	getName()	Returns the name of the method.
JParameter	getParameter(int index)	Returns the JParameter at the given index.
protected java.lang.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(java.lang.String comment)	Sets the comment describing this JMethodSignature.
void	setModifiers(JModifiers modifiers)	Sets the JModifiers for this method signature.
java.lang.String	toString()	Returns the String representation of this JMethod, which is the method prototype.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JMethodSignature

public JMethodSignature(java.lang.String name,
                        JType returnType)

Creates a new method with the given name and return type. For "void" return types, simply pass in null as the returnType

Parameters:

name - , the method name. Must not be null.

returnType - the return type of the method. May be null.

Method Detail

addException

public void addException(JClass exp)

Adds the given Exception to this JMethodSignature's throws clause.

Parameters:

exp - the JClass representing the Exception

addParameter

public void addParameter(JParameter parameter)
                  throws java.lang.IllegalArgumentException

Adds the given parameter to this JMethodSignature's list of parameters.

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.

getExceptions

public JClass[] getExceptions()

Returns the exceptions that this JMethodSignature lists in it's throws clause.

Returns:

the exceptions that this JMethodSignature lists in it's throws clause.

getJDocComment

public JDocComment getJDocComment()

Returns the JDocComment describing this JMethodSignature

Returns:

the JDocComment describing this JMethodSignature

getModifiers

public JModifiers getModifiers()

Returns the modifiers for this JMethodSignature.

Returns:

the modifiers for this JMethodSignature.

getName

public java.lang.String getName()

Returns the name of the method.

Returns:

the name of the method.

getParameter

public JParameter getParameter(int index)

Returns the JParameter at the given index.

Parameters:

index - the index of the JParameter to return.

Returns:

the JParameter at the given index.

getParameters

public 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.

Returns:

the set of JParameters for this JMethod

getReturnType

public JType getReturnType()

Returns the JType that represents the return type for the method signature.

Returns:

the JType that represents the return type for the method signature.

setComment

public void setComment(java.lang.String comment)

Sets the comment describing this JMethodSignature.

Parameters:

comment - the comment for this member

See Also:

getJDocComment()

setModifiers

public void setModifiers(JModifiers modifiers)

Sets the JModifiers for this method signature.

Parameters:

modifiers - the JModifiers for this method signature.

print

public void print(JSourceWriter jsw)

Prints the method signature. A semi-colon (end-of-statement terminator ';') will Not be printed.

Parameters:

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.

Parameters:

jsw - the JSourceWriter to print to.

printJavaDoc - a boolean that when true prints the JDocComment associated with this method signature.

toString

public java.lang.String toString()

Returns the String representation of this JMethod, which is the method prototype.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this JMethod, which is simply the method prototype

getParameterClassNames

protected java.lang.String[] getParameterClassNames()