mx4j

Class MBeanDescriptionAdapter

Implemented Interfaces:
MBeanDescription
Known Direct Subclasses:
CosNamingServiceMBeanDescription, DefaultMBeanServerInterceptorMBeanDescription, HttpAdaptorMBeanDescription, InvokerMBeanServerInterceptorMBeanDescription, JythonRunnerMBeanDescription, MBeanServerInterceptorConfiguratorMBeanDescription, NamingServiceMBeanDescription, ProcessorMBeanDescription, SecurityMBeanServerInterceptorMBeanDescription, SSLAdaptorServerSocketFactoryMBeanDescription, StatisticsRecorderMBeanDescription

public class MBeanDescriptionAdapter
extends java.lang.Object
implements MBeanDescription

Default implementation for the MBeanDescription interface.
Version:
$Revision: 1.5 $

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 Details

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"
Specified by:
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"
Specified by:
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"
Specified by:
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"
Specified by:
getConstructorParameterName in interface MBeanDescription

getMBeanDescription

public String getMBeanDescription()
Should return the description of the MBean. For example: "This MBean is the rmiregistry service"
Specified by:
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"
Specified by:
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"
Specified by:
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"
Specified by:
getOperationParameterName in interface MBeanDescription

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