Top Description Fields Constructors Methods
org.apache.tomcat.util.modeler

public Class OperationInfo

extends FeatureInfo
Class Inheritance
Imports
java.util.Locale, java.util.concurrent.locks.Lock, .ReadWriteLock, .ReentrantReadWriteLock, javax.management.MBeanOperationInfo, .MBeanParameterInfo

Internal configuration information for an Operation descriptor.

Author
Craig R. McClanahan

Field Summary

Modifier and TypeField and Description
protected String
protected ParameterInfo[]
protected final ReadWriteLock
protected String
private static final long
Inherited from org.apache.tomcat.util.modeler.FeatureInfo:
descriptioninfonametype

Constructor Summary

AccessConstructor and Description
public
OperationInfo()

Standard zero-arguments constructor.

Method Summary

Modifier and TypeMethod and Description
public void
addParameter(ParameterInfo
The new parameter descriptor
parameter
)

Add a new parameter to the set of arguments for this operation.

pack-priv MBeanOperationInfo

Returns:

the operation info
createOperationInfo
()

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

public String

Returns:

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

protected MBeanParameterInfo[]
public String

Returns:

the fully qualified Java class name of the return type for this operation.
getReturnType
()

public String

Returns:

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

public ParameterInfo[]

Returns:

the set of parameters for this operation.
getSignature
()

public void
setImpact(String impact)

public void
setReturnType(String returnType)

public void
Inherited from org.apache.tomcat.util.modeler.FeatureInfo:
getDescriptiongetNamegetTypesetDescriptionsetNamesetType

Field Detail

impactback to summary
protected String impact
parametersback to summary
protected ParameterInfo[] parameters
parametersLockback to summary
protected final ReadWriteLock parametersLock
roleback to summary
protected String role
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.tomcat.util.modeler.FeatureInfo.serialVersionUID.

Constructor Detail

OperationInfoback to summary
public OperationInfo()

Standard zero-arguments constructor.

Method Detail

addParameterback to summary
public void addParameter(ParameterInfo parameter)

Add a new parameter to the set of arguments for this operation.

Parameters
parameter:ParameterInfo

The new parameter descriptor

createOperationInfoback to summary
pack-priv MBeanOperationInfo createOperationInfo()

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

Returns:MBeanOperationInfo

the operation info

getImpactback to summary
public String getImpact()
Returns:String

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

getMBeanParameterInfoback to summary
protected MBeanParameterInfo[] getMBeanParameterInfo()
getReturnTypeback to summary
public String getReturnType()
Returns:String

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

getRoleback to summary
public String getRole()
Returns:String

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

getSignatureback to summary
public ParameterInfo[] getSignature()
Returns:ParameterInfo[]

the set of parameters for this operation.

setImpactback to summary
public void setImpact(String impact)
setReturnTypeback to summary
public void setReturnType(String returnType)
setRoleback to summary
public void setRole(String role)