## mx4j
Interface MBeanDescription

All Known Implementing Classes:
  MBeanDescriptionAdapter

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.

Version:
  $Revision: 1.5 $

Method Summary
`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.

Method Detail

### getMBeanDescription

    public java.lang.String getMBeanDescription()

  Should return the description of the MBean. For example: "This MBean is the rmiregistry service"

### getConstructorDescription

    public java.lang.String getConstructorDescription(java.lang.reflect.Constructor ctor)

  Should return the description for the given constructor of the MBean. For example: "Creates an rmiregistry instance on the specified port"

### getConstructorParameterName

    public 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. For example: "port"

### getConstructorParameterDescription

    public 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. For example: "The port on which the rmiregistry will wait on for client requests"

### getAttributeDescription

    public java.lang.String getAttributeDescription(java.lang.String attribute)

  Should return the description for the specified attribute. For example: "The port on which the rmiregistry will wait on for client requests"

### getOperationDescription

    public java.lang.String getOperationDescription(java.lang.reflect.Method operation)

  Should return the description for the specified operation. For example: "Binds the given object to the given name"

### getOperationParameterName

    public 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. For example: "bindName"

### getOperationParameterDescription

    public 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. For example: "The name to which the object will be bound to"

Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.