public interface MBeanDescription
The MX4J implementation will look, for every standard MBean, for a class with name composed by the fully qualified MBean class name + "MBeanDescription". If such a class is found, the MX4J implementation will call its methods to retrieve description information about the MBean itself. MBean descriptions are built-in in DynamicMBean, but not in standard MBeans. The XDoclet tool is used to automate the process of generating the MBeanDescription classes for a given MBean, along with the MBean interface.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttributeDescription(java.lang.String attribute)
Should return the description for the specified attribute.
|
java.lang.String |
getConstructorDescription(java.lang.reflect.Constructor ctor)
Should return the description for the given constructor of the MBean.
|
java.lang.String |
getConstructorParameterDescription(java.lang.reflect.Constructor ctor,
int index)
Should return the description for the constructor's parameter for the given constructor and parameter index.
|
java.lang.String |
getConstructorParameterName(java.lang.reflect.Constructor ctor,
int index)
Should return the name of the constructor's parameter for the given constructor and parameter index.
|
java.lang.String |
getMBeanDescription()
Should return the description of the MBean.
|
java.lang.String |
getOperationDescription(java.lang.reflect.Method operation)
Should return the description for the specified operation.
|
java.lang.String |
getOperationParameterDescription(java.lang.reflect.Method method,
int index)
Should return the description for the operations's parameter for the given operation and parameter index.
|
java.lang.String |
getOperationParameterName(java.lang.reflect.Method method,
int index)
Should return the name of the operation's parameter for the given operation and parameter index.
|
java.lang.String getMBeanDescription()
java.lang.String getConstructorDescription(java.lang.reflect.Constructor ctor)
java.lang.String getConstructorParameterName(java.lang.reflect.Constructor ctor, int index)
java.lang.String getConstructorParameterDescription(java.lang.reflect.Constructor ctor, int index)
java.lang.String getAttributeDescription(java.lang.String attribute)
java.lang.String getOperationDescription(java.lang.reflect.Method operation)
java.lang.String getOperationParameterName(java.lang.reflect.Method method, int index)
java.lang.String getOperationParameterDescription(java.lang.reflect.Method method, int index)