Package org.apache.commons.modeler
Class OperationInfo
java.lang.Object
org.apache.commons.modeler.FeatureInfo
org.apache.commons.modeler.OperationInfo
- All Implemented Interfaces:
Serializable
Internal configuration information for an Operation
descriptor.
- Version:
- $Revision: 480402 $ $Date: 2006-11-29 04:43:23 +0000 (Wed, 29 Nov 2006) $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
(package private) ModelMBeanOperationInfo
TheModelMBeanOperationInfo
object that corresponds to thisOperationInfo
instance.protected ParameterInfo[]
protected String
protected String
(package private) static final long
Fields inherited from class org.apache.commons.modeler.FeatureInfo
description, fields, name
-
Constructor Summary
ConstructorsConstructorDescriptionStandard zero-arguments constructor.OperationInfo
(String name, boolean getter, String type) Special constructor for setting up getter and setter operations. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameter
(ParameterInfo parameter) Add a new parameter to the set of arguments for this operation.Create and return aModelMBeanOperationInfo
object that corresponds to the attribute described by this instance.The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".The fully qualified Java class name of the return type for this operation.getRole()
The role of this operation ("getter", "setter", "operation", or "constructor").The set of parameters for this operation.void
setDescription
(String description) Override thedescription
property setter.void
void
Override thename
property setter.void
setReturnType
(String returnType) void
toString()
Return a string representation of this operation descriptor.Methods inherited from class org.apache.commons.modeler.FeatureInfo
addField, addFields, getDescription, getFields, getName
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
info
TheModelMBeanOperationInfo
object that corresponds to thisOperationInfo
instance. -
impact
-
role
-
returnType
-
parameters
-
-
Constructor Details
-
OperationInfo
public OperationInfo()Standard zero-arguments constructor. -
OperationInfo
Special constructor for setting up getter and setter operations.- Parameters:
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)
-
-
Method Details
-
setDescription
Override thedescription
property setter.- Overrides:
setDescription
in classFeatureInfo
- Parameters:
description
- The new description
-
setName
Override thename
property setter.- Overrides:
setName
in classFeatureInfo
- Parameters:
name
- The new name
-
getImpact
The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN". -
setImpact
-
getRole
The role of this operation ("getter", "setter", "operation", or "constructor"). -
setRole
-
getReturnType
The fully qualified Java class name of the return type for this operation. -
setReturnType
-
getSignature
The set of parameters for this operation. -
addParameter
Add a new parameter to the set of arguments for this operation.- Parameters:
parameter
- The new parameter descriptor
-
createOperationInfo
Create and return aModelMBeanOperationInfo
object that corresponds to the attribute described by this instance. -
toString
Return a string representation of this operation descriptor.
-