Class JParameter

java.lang.Object

org.exolab.javasource.JAnnotatedElementHelper

org.exolab.javasource.JParameter

All Implemented Interfaces:

JAnnotatedElement

public final class JParameter
extends JAnnotatedElementHelper

Represents a parameter to a JMethod.

Version:

$Revision: 7918 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Keith Visco

Constructor Summary

Constructors

Constructor	Description
JParameter(JType type, String name)	Creates a new JParameter with the given type, and name.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the parameter.
JType	getType()	Returns the parameter type.
void	setName(String name)	Sets the name of this parameter.
void	setType(JType type)	Sets the type of this parameter.
String	toString()	Returns the String representation of this JParameter.

Methods inherited from class JAnnotatedElementHelper

addAnnotation, getAnnotation, getAnnotations, hasAnnotations, isAnnotationPresent, printAnnotations, removeAnnotation

Modifier and Type	Method	Description
final void	addAnnotation(JAnnotation annotation)	Adds a JAnnotation to this source element.
final JAnnotation	getAnnotation(JAnnotationType annotationType)	Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
final JAnnotation[]	getAnnotations()	Returns a list of JAnnotation's already set on this source element.
final boolean	hasAnnotations()	Returns true if this source element has any annotations.
final boolean	isAnnotationPresent(JAnnotationType annotationType)	Returns true if a JAnnotation exists for the given JAnnotationType.
final boolean	printAnnotations(JSourceWriter jsw)	Outputs the list of annotations maintained by this object.
final JAnnotation	removeAnnotation(JAnnotationType annotationType)	Removes the JAnnotation from this source element for the given JAnnotationType.

Methods inherited from class Object

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

Constructor Details

JParameter

public JParameter(JType type,
 String name)

Creates a new JParameter with the given type, and name.

Parameters:

type - The JType to associate with this JParameter.

name - Name of the JParameter.

Method Details

getName

public String getName()

Returns the name of the parameter.

Returns:

The name of the parameter.

getType

public JType getType()

Returns the parameter type.

Returns:

The parameter type.

setName

public void setName(String name)

Sets the name of this parameter.

Parameters:

name - The new name of the parameter.

setType

public void setType(JType type)

Sets the type of this parameter.

Parameters:

type - The new JType of this parameter.

toString

public String toString()

Returns the String representation of this JParameter. The String returned will consist of the String representation of the parameter type followed by the name of the parameter.

Overrides:

toString in class Object