org.apache.commons.modeler
Class OperationInfo
- Serializable
public class OperationInfo
implements Serializable
Internal configuration information for an Operation
descriptor.
$Revision: 1.6 $ $Date: 2003/07/20 07:35:13 $
OperationInfo() - Standard zero-arguments constructor.
|
OperationInfo(String name, boolean getter, String type) - Special constructor for setting up getter and setter operations.
|
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.
|
impact
protected String impact
info
(package private) ModelMBeanOperationInfo info
The ModelMBeanOperationInfo
object that corresponds
to this OperationInfo
instance.
returnType
protected String returnType
role
protected String role
serialVersionUID
(package private) static final long serialVersionUID
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.
name
- Name of this operationgetter
- 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)
addParameter
public void addParameter(ParameterInfo parameter)
Add a new parameter to the set of arguments for this operation.
parameter
- The new parameter descriptor
createOperationInfo
public ModelMBeanOperationInfo createOperationInfo()
Create and return a ModelMBeanOperationInfo
object that
corresponds to the attribute described by this instance.
getImpact
public String getImpact()
The "impact" of this operation, which should be a (case-insensitive)
string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
getReturnType
public String getReturnType()
The fully qualified Java class name of the return type for this
operation.
getRole
public String getRole()
The role of this operation ("getter", "setter", "operation", or
"constructor").
getSignature
public ParameterInfo[] getSignature()
The set of parameters for this operation.
setDescription
public void setDescription(String description)
Override the description
property setter.
- setDescription in interface FeatureInfo
description
- The new description
setImpact
public void setImpact(String impact)
setName
public void setName(String name)
Override the name
property setter.
- setName in interface FeatureInfo
setReturnType
public void setReturnType(String returnType)
setRole
public void setRole(String role)
toString
public String toString()
Return a string representation of this operation descriptor.
Copyright (c) 2001-2003 - Apache Software Foundation