org.apache.commons.modeler

Class OperationInfo

public class OperationInfo extends FeatureInfo implements Serializable

Internal configuration information for an Operation descriptor.

Version: $Revision: 480402 $ $Date: 2006-11-29 04:43:23 +0000 (Wed, 29 Nov 2006) $

Author: Craig R. McClanahan

Field Summary
protected Stringimpact
protected ParameterInfo[]parameters
protected StringreturnType
protected Stringrole
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
voidaddParameter(ParameterInfo parameter)
Add a new parameter to the set of arguments for this operation.
ModelMBeanOperationInfocreateOperationInfo()
Create and return a ModelMBeanOperationInfo object that corresponds to the attribute described by this instance.
StringgetImpact()
The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
StringgetReturnType()
The fully qualified Java class name of the return type for this operation.
StringgetRole()
The role of this operation ("getter", "setter", "operation", or "constructor").
ParameterInfo[]getSignature()
The set of parameters for this operation.
voidsetDescription(String description)
Override the description property setter.
voidsetImpact(String impact)
voidsetName(String name)
Override the name property setter.
voidsetReturnType(String returnType)
voidsetRole(String role)
StringtoString()
Return a string representation of this operation descriptor.

Field Detail

impact

protected String impact

parameters

protected ParameterInfo[] parameters

returnType

protected String returnType

role

protected String role

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)

Method Detail

addParameter

public void addParameter(ParameterInfo parameter)
Add a new parameter to the set of arguments for this operation.

Parameters: 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.

Parameters: description The new description

setImpact

public void setImpact(String impact)

setName

public void setName(String name)
Override the name property setter.

Parameters: name The new name

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 © 2002-2009 Apache Software Foundation. All Rights Reserved.