org.apache.commons.modeler

Class OperationInfo

public class OperationInfo extends FeatureInfo implements Serializable

Internal configuration information for an Operation descriptor.

Version: $Revision: 155428 $ $Date: 2005-02-26 08:12:25 -0500 (Sat, 26 Feb 2005) $

Author: Craig R. McClanahan

Field Summary
protected String	impact
ModelMBeanOperationInfo	info The `ModelMBeanOperationInfo` object that corresponds to this `OperationInfo` instance.
protected ParameterInfo[]	parameters
protected String	returnType
protected String	role
static long	serialVersionUID

Constructor Summary
	OperationInfo() Standard zero-arguments constructor.
	OperationInfo(String name, boolean getter, String type) Special constructor for setting up getter and setter operations.

Method Summary
void	addParameter(ParameterInfo parameter) Add a new parameter to the set of arguments for this operation.
ModelMBeanOperationInfo	createOperationInfo() Create and return a `ModelMBeanOperationInfo` object that corresponds to the attribute described by this instance.
String	getImpact() The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
String	getReturnType() The fully qualified Java class name of the return type for this operation.
String	getRole() The role of this operation ("getter", "setter", "operation", or "constructor").
ParameterInfo[]	getSignature() The set of parameters for this operation.
void	setDescription(String description) Override the `description` property setter.
void	setImpact(String impact)
void	setName(String name) Override the `name` property setter.
void	setReturnType(String returnType)
void	setRole(String role)
String	toString() Return a string representation of this operation descriptor.

Field Detail

impact

protected String impact

info

transient ModelMBeanOperationInfo info

The ModelMBeanOperationInfo object that corresponds to this OperationInfo instance.

parameters

protected ParameterInfo[] parameters

returnType

protected String returnType

role

protected String role

serialVersionUID

static final long serialVersionUID

Constructor Detail

OperationInfo

public OperationInfo()

Standard zero-arguments constructor.

OperationInfo

public OperationInfo(String name, boolean getter, String type)

Special constructor for setting up getter and setter operations.

Parameters: name Name of this operation getter Is this a getter (as opposed to a setter)? type Data type of the return value (if this is a getter) or the parameter (if this is a setter)