org.apache.commons.modeler

Class OperationInfo

Implemented Interfaces:
Serializable

public class OperationInfo
extends FeatureInfo
implements Serializable

Internal configuration information for an Operation descriptor.
Version:
$Revision: 1.6 $ $Date: 2003/07/20 07:35:13 $
Author:
Craig R. McClanahan

Field Summary

protected String
impact
(package private) ModelMBeanOperationInfo
info
The ModelMBeanOperationInfo object that corresponds to this OperationInfo instance.
protected ParameterInfo[]
parameters
protected String
returnType
protected String
role
(package private) static long
serialVersionUID

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

description, fields, name, serialVersionUID

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.
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, setDescription, setName

Field Details

impact

protected String impact

info

(package private)  ModelMBeanOperationInfo info
The ModelMBeanOperationInfo object that corresponds to this OperationInfo instance.

parameters

protected ParameterInfo[] parameters

returnType

protected String returnType

role

protected String role

serialVersionUID

(package private) static final long serialVersionUID
Field Value:
4418342922072614875L

Constructor Details

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 Details

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.
Overrides:
setDescription in interface FeatureInfo
Parameters:
description - The new description

setImpact

public void setImpact(String impact)

setName

public void setName(String name)
Override the name property setter.
Overrides:
setName in interface FeatureInfo
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 (c) 2001-2003 - Apache Software Foundation