mx4j
Class MBeanDescriptionAdapter
java.lang.Object
mx4j.MBeanDescriptionAdapter
- MBeanDescription
public class MBeanDescriptionAdapter
extends java.lang.Object
Default implementation for the MBeanDescription interface.
String | getAttributeDescription(String attribute) - Should return the description for the specified attribute.
|
String | getConstructorDescription(Constructor ctor) - Should return the description for the given constructor of the MBean.
|
String | getConstructorParameterDescription(Constructor ctor, int index) - Should return the description for the constructor's parameter for the given constructor and parameter index.
|
String | getConstructorParameterName(Constructor ctor, int index) - Should return the name of the constructor's parameter for the given constructor and parameter index.
|
String | getMBeanDescription() - Should return the description of the MBean.
|
String | getOperationDescription(Method operation) - Should return the description for the specified operation.
|
String | getOperationParameterDescription(Method method, int index) - Should return the description for the operations's parameter for the given operation and parameter index.
|
String | getOperationParameterName(Method method, int index) - Should return the name of the operation's parameter for the given operation and parameter index.
|
getAttributeDescription
public String getAttributeDescription(String attribute)
Should return the description for the specified attribute.
For example: "The port on which the rmiregistry will wait on for client requests"
- getAttributeDescription in interface MBeanDescription
getConstructorDescription
public String getConstructorDescription(Constructor ctor)
Should return the description for the given constructor of the MBean.
For example: "Creates an rmiregistry instance on the specified port"
- getConstructorDescription in interface MBeanDescription
getConstructorParameterDescription
public String getConstructorParameterDescription(Constructor ctor,
int index)
Should return the description for the constructor's parameter for the given constructor and parameter index.
For example: "The port on which the rmiregistry will wait on for client requests"
- getConstructorParameterDescription in interface MBeanDescription
getConstructorParameterName
public String getConstructorParameterName(Constructor ctor,
int index)
Should return the name of the constructor's parameter for the given constructor and parameter index.
For example: "port"
- getConstructorParameterName in interface MBeanDescription
getMBeanDescription
public String getMBeanDescription()
Should return the description of the MBean.
For example: "This MBean is the rmiregistry service"
- getMBeanDescription in interface MBeanDescription
getOperationDescription
public String getOperationDescription(Method operation)
Should return the description for the specified operation.
For example: "Binds the given object to the given name"
- getOperationDescription in interface MBeanDescription
getOperationParameterDescription
public String getOperationParameterDescription(Method method,
int index)
Should return the description for the operations's parameter for the given operation and parameter index.
For example: "The name to which the object will be bound to"
- getOperationParameterDescription in interface MBeanDescription
getOperationParameterName
public String getOperationParameterName(Method method,
int index)
Should return the name of the operation's parameter for the given operation and parameter index.
For example: "bindName"
- getOperationParameterName in interface MBeanDescription
Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.