|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.modeler.FeatureInfo | +--org.apache.commons.modeler.OperationInfo
Internal configuration information for an Operation
descriptor.
Field Summary | |
protected String |
impact
|
protected ParameterInfo[] |
parameters
|
protected String |
returnType
|
protected String |
role
|
Fields inherited from class org.apache.commons.modeler.FeatureInfo |
description, fields, name |
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. |
javax.management.modelmbean.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. |
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 Detail |
protected String impact
protected String role
protected String returnType
protected ParameterInfo[] parameters
Constructor Detail |
public OperationInfo()
public OperationInfo(String name, boolean getter, String type)
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 Detail |
public void setDescription(String description)
description
property setter.setDescription
in class FeatureInfo
description
- The new descriptionpublic void setName(String name)
name
property setter.setName
in class FeatureInfo
name
- The new namepublic String getImpact()
public void setImpact(String impact)
public String getRole()
public void setRole(String role)
public String getReturnType()
public void setReturnType(String returnType)
public ParameterInfo[] getSignature()
public void addParameter(ParameterInfo parameter)
parameter
- The new parameter descriptorpublic javax.management.modelmbean.ModelMBeanOperationInfo createOperationInfo()
ModelMBeanOperationInfo
object that
corresponds to the attribute described by this instance.public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |