com.continuent.tungsten.common.jmx
Class DynamicMBeanOperation

java.lang.Object
  com.continuent.tungsten.common.jmx.DynamicMBeanOperation

All Implemented Interfaces:

java.io.Serializable

public class DynamicMBeanOperation
extends java.lang.Object
implements java.io.Serializable

Version:

1.0

Author:

Edward Archibald

See Also:

Serialized Form

Constructor Summary

DynamicMBeanOperation(java.lang.reflect.Method method, javax.management.MBeanOperationInfo info)

Method Summary

java.lang.String	defaultUsage()
java.lang.String	formatParams(java.util.Map<java.lang.String,DynamicMBeanParam> params, boolean includeDescription) Single line representation of parameters.
java.lang.String	getDescription() Returns the description value.
java.lang.String	getName() Returns the name value.
java.lang.String	getParamDescription(boolean multiLine, java.lang.String linePrefix)
java.lang.String[]	getSignature()
java.lang.String	getUsage() Returns the usage value.
void	setDescription(java.lang.String description) Sets the description value.
void	setName(java.lang.String name) Sets the name value.
void	setSignature(java.util.Vector<java.lang.String> signature) Sets the signature value.
void	setUsage(java.lang.String usage) Sets the usage value.
java.lang.String	toString()
java.lang.Object[]	validateAndGetNamedParams(java.util.Map<java.lang.String,java.lang.Object> paramMap) This method converts a map of named parameters into a position-ordered set of parameters.
java.lang.Object[]	validateAndGetPositionalParams(java.util.Map<java.lang.String,java.lang.Object> paramMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicMBeanOperation

public DynamicMBeanOperation(java.lang.reflect.Method method,
                             javax.management.MBeanOperationInfo info)

Parameters:

method -

info -

Method Detail

getSignature

public java.lang.String[] getSignature()

Returns:

the signature of this operation

validateAndGetNamedParams

public java.lang.Object[] validateAndGetNamedParams(java.util.Map<java.lang.String,java.lang.Object> paramMap)
                                             throws java.lang.Exception

This method converts a map of named parameters into a position-ordered set of parameters. At the same time that it is doing this, it verifies that all parameters have been supplied, and that the types are correct.

Parameters:

paramMap -

Returns:

an array of objects in param order

Throws:

java.lang.Exception

validateAndGetPositionalParams

public java.lang.Object[] validateAndGetPositionalParams(java.util.Map<java.lang.String,java.lang.Object> paramMap)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

formatParams

public java.lang.String formatParams(java.util.Map<java.lang.String,DynamicMBeanParam> params,
                                     boolean includeDescription)

Single line representation of parameters.

getParamDescription

public java.lang.String getParamDescription(boolean multiLine,
                                            java.lang.String linePrefix)

getName

public java.lang.String getName()

Returns the name value.

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Sets the name value.

Parameters:

name - The name to set.

getDescription

public java.lang.String getDescription()

Returns the description value.

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Sets the description value.

Parameters:

description - The description to set.

getUsage

public java.lang.String getUsage()

Returns the usage value.

Returns:

Returns the usage.

setUsage

public void setUsage(java.lang.String usage)

Sets the usage value.

Parameters:

usage - The usage to set.

setSignature

public void setSignature(java.util.Vector<java.lang.String> signature)

Sets the signature value.

Parameters:

signature - The signature to set.

defaultUsage

public java.lang.String defaultUsage()