org.apache.commons.modeler
Class OperationInfo

java.lang.Object
  org.apache.commons.modeler.FeatureInfo
      org.apache.commons.modeler.OperationInfo

All Implemented Interfaces:

java.io.Serializable

public class OperationInfo
extends FeatureInfo
implements java.io.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

See Also:

Serialized Form

Field Summary

protected java.lang.String	impact
protected ParameterInfo[]	parameters
protected java.lang.String	returnType
protected java.lang.String	role

Fields inherited from class org.apache.commons.modeler.FeatureInfo

description, fields, name

Constructor Summary

OperationInfo()
Standard zero-arguments constructor.

OperationInfo(java.lang.String name, boolean getter, java.lang.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.
java.lang.String	getImpact() The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
java.lang.String	getReturnType() The fully qualified Java class name of the return type for this operation.
java.lang.String	getRole() The role of this operation ("getter", "setter", "operation", or "constructor").
ParameterInfo[]	getSignature() The set of parameters for this operation.
void	setDescription(java.lang.String description) Override the description property setter.
void	setImpact(java.lang.String impact)
void	setName(java.lang.String name) Override the name property setter.
void	setReturnType(java.lang.String returnType)
void	setRole(java.lang.String role)
java.lang.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

impact

protected java.lang.String impact

role

protected java.lang.String role

returnType

protected java.lang.String returnType

parameters

protected ParameterInfo[] parameters

Constructor Detail

OperationInfo

public OperationInfo()

Standard zero-arguments constructor.

OperationInfo

public OperationInfo(java.lang.String name,
                     boolean getter,
                     java.lang.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

setDescription

public void setDescription(java.lang.String description)

Override the description property setter.

Overrides:

setDescription in class FeatureInfo

Parameters:

description - The new description

setName

public void setName(java.lang.String name)

Override the name property setter.

Overrides:

setName in class FeatureInfo

Parameters:

name - The new name

getImpact

public java.lang.String getImpact()

The "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".

setImpact

public void setImpact(java.lang.String impact)

getRole

public java.lang.String getRole()

The role of this operation ("getter", "setter", "operation", or "constructor").

setRole

public void setRole(java.lang.String role)

getReturnType

public java.lang.String getReturnType()

The fully qualified Java class name of the return type for this operation.

setReturnType

public void setReturnType(java.lang.String returnType)

getSignature

public ParameterInfo[] getSignature()

The set of parameters for this operation.

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 javax.management.modelmbean.ModelMBeanOperationInfo createOperationInfo()

Create and return a ModelMBeanOperationInfo object that corresponds to the attribute described by this instance.

toString

public java.lang.String toString()

Return a string representation of this operation descriptor.

Overrides:

toString in class java.lang.Object