Package org.apache.commons.modeler

Class ParameterInfo

java.lang.Object

org.apache.commons.modeler.FeatureInfo

org.apache.commons.modeler.ParameterInfo

All Implemented Interfaces:

Serializable

public class ParameterInfo
extends FeatureInfo
implements Serializable

Internal configuration information for a Parameter descriptor.

Version:

$Revision: 480402 $ $Date: 2006-11-29 04:43:23 +0000 (Wed, 29 Nov 2006) $

Author:

Craig R. McClanahan

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) MBeanParameterInfo	info	The MBeanParameterInfo object that corresponds to this ParameterInfo instance.
(package private) static final long	serialVersionUID
protected String	type

Fields inherited from class org.apache.commons.modeler.FeatureInfo

description, fields, name

Constructor Summary

Constructors

Constructor	Description
ParameterInfo()	Standard zero-arguments constructor.
ParameterInfo(String name, String type, String description)	Special constructor for setting up parameters programatically.

Method Summary

Modifier and Type	Method	Description
MBeanParameterInfo	createParameterInfo()	Create and return a MBeanParameterInfo object that corresponds to the parameter described by this instance.
String	getType()	The fully qualified Java class name of this parameter.
void	setDescription(String description)	Override the description property setter.
void	setName(String name)	Override the name property setter.
void	setType(String type)
String	toString()	Return a string representation of this parameter descriptor.

Methods inherited from class org.apache.commons.modeler.FeatureInfo

addField, addFields, getDescription, getFields, getName

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

static final long serialVersionUID

See Also:

• Constant Field Values

info

transient MBeanParameterInfo info

The MBeanParameterInfo object that corresponds to this ParameterInfo instance.

type

protected String type

Constructor Details

ParameterInfo

public ParameterInfo()

Standard zero-arguments constructor.

ParameterInfo

public ParameterInfo(String name,
 String type,
 String description)

Special constructor for setting up parameters programatically.

Parameters:

name - Name of this parameter

type - Java class of this parameter

description - Description of this parameter

Method Details

setDescription

public void setDescription(String description)

Override the description property setter.

Overrides:

setDescription in class FeatureInfo

Parameters:

description - The new description

setName

public void setName(String name)

Override the name property setter.

Overrides:

setName in class FeatureInfo

Parameters:

name - The new name

getType

public String getType()

The fully qualified Java class name of this parameter.

setType

public void setType(String type)

createParameterInfo

public MBeanParameterInfo createParameterInfo()

Create and return a MBeanParameterInfo object that corresponds to the parameter described by this instance.

toString

public String toString()

Return a string representation of this parameter descriptor.

Overrides:

toString in class Object