|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MBeanDescription
Implement this inteface to give descriptions to standard MBean.
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.
Method Summary | |
---|---|
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. |
Method Detail |
---|
String getMBeanDescription()
String getConstructorDescription(Constructor ctor)
String getConstructorParameterName(Constructor ctor, int index)
String getConstructorParameterDescription(Constructor ctor, int index)
String getAttributeDescription(String attribute)
String getOperationDescription(Method operation)
String getOperationParameterName(Method method, int index)
String getOperationParameterDescription(Method method, int index)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |