public class OperationInfo extends FeatureInfo implements Serializable
Internal configuration information for an Operation
descriptor.
Modifier and Type | Field and Description |
---|---|
protected String |
impact |
protected ParameterInfo[] |
parameters |
protected String |
returnType |
protected String |
role |
description, fields, name
Constructor and Description |
---|
OperationInfo()
Standard zero-arguments constructor.
|
OperationInfo(String name,
boolean getter,
String type)
Special constructor for setting up getter and setter operations.
|
Modifier and Type | Method and Description |
---|---|
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.
|
addField, addFields, getDescription, getFields, getName
protected String impact
protected String role
protected String returnType
protected ParameterInfo[] parameters
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)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 ModelMBeanOperationInfo createOperationInfo()
ModelMBeanOperationInfo
object that
corresponds to the attribute described by this instance.Copyright © 2002–2018 The Apache Software Foundation. All rights reserved.