org.apache.commons.modeler

Class ParameterInfo

Implemented Interfaces:
Serializable

public class ParameterInfo
extends FeatureInfo
implements Serializable

Internal configuration information for a Parameter descriptor.
Version:
$Revision: 1.5 $ $Date: 2003/07/20 07:35:12 $
Author:
Craig R. McClanahan

Field Summary

(package private) MBeanParameterInfo
info
The MBeanParameterInfo object that corresponds to this ParameterInfo instance.
(package private) static long
serialVersionUID
protected String
type

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

description, fields, name, serialVersionUID

Constructor Summary

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

Method Summary

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, setDescription, setName

Field Details

info

(package private)  MBeanParameterInfo info
The MBeanParameterInfo object that corresponds to this ParameterInfo instance.

serialVersionUID

(package private) static final long serialVersionUID
Field Value:
2222796006787664020L

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

createParameterInfo

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

getType

public String getType()
The fully qualified Java class name of this parameter.

setDescription

public void setDescription(String description)
Override the description property setter.
Overrides:
setDescription in interface FeatureInfo
Parameters:
description - The new description

setName

public void setName(String name)
Override the name property setter.
Overrides:
setName in interface FeatureInfo
Parameters:
name - The new name

setType

public void setType(String type)

toString

public String toString()
Return a string representation of this parameter descriptor.

Copyright (c) 2001-2003 - Apache Software Foundation