org.objectweb.cjdbc.controller.jmx
Class ExtendedMBeanDescriptionAdapter

java.lang.Object
  extended bymx4j.MBeanDescriptionAdapter
      extended byorg.objectweb.cjdbc.controller.jmx.ExtendedMBeanDescriptionAdapter
All Implemented Interfaces:
mx4j.MBeanDescription
Direct Known Subclasses:
ControllerMBeanDescription, VirtualDatabaseMBeanDescription

public abstract class ExtendedMBeanDescriptionAdapter
extends mx4j.MBeanDescriptionAdapter

Controller MBean description.

Version:
1.0
Author:
Emmanuel Cecchet

Constructor Summary
ExtendedMBeanDescriptionAdapter()
           
 
Method Summary
abstract  java.lang.String getAssociatedString()
          Allow to retrieve internationalization description on mbeans as well
 java.lang.String getAttributeDescription(java.lang.String attribute)
          Returns the description for the specified attribute.
 java.lang.String getConstructorDescription(java.lang.reflect.Constructor ctor)
          Returns the description for the specified constructor.
 java.lang.String getConstructorParameterDescription(java.lang.reflect.Constructor ctor, int index)
          Should return the description for the given constructor of the MBean.
 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()
          Returns the description of the MBean.
 java.lang.String getOperationDescription(java.lang.reflect.Method operation)
          Returns the description for the specified operation.
 java.lang.String getOperationParameterDescription(java.lang.reflect.Method method, int index)
          Returns the description of the operation's parameter for the given operation and parameter index.
 java.lang.String getOperationParameterName(java.lang.reflect.Method method, int index)
          Returns the name of the operation's parameter for the given operation and parameter index.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExtendedMBeanDescriptionAdapter

public ExtendedMBeanDescriptionAdapter()
Method Detail

getAssociatedString

public abstract java.lang.String getAssociatedString()
Allow to retrieve internationalization description on mbeans as well

Returns:
part of the key to look for in the translation file.

getMBeanDescription

public java.lang.String getMBeanDescription()
Returns the description of the MBean.

Returns:
a String containing the description

getConstructorDescription

public java.lang.String getConstructorDescription(java.lang.reflect.Constructor ctor)
Returns the description for the specified constructor.

Parameters:
ctor - the constructor
Returns:
a String containing the description

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"

Parameters:
ctor - constructor
index - index of parameter
Returns:
description

getConstructorParameterDescription

public java.lang.String getConstructorParameterDescription(java.lang.reflect.Constructor ctor,
                                                           int index)
Should return the description for the given constructor of the MBean. For example: "Creates an rmiregistry instance on the specified port"

Parameters:
ctor - constructor
index - index of parameter
Returns:
description

getAttributeDescription

public java.lang.String getAttributeDescription(java.lang.String attribute)
Returns the description for the specified attribute.

Parameters:
attribute - the attribute name
Returns:
a String containing the description

getOperationDescription

public java.lang.String getOperationDescription(java.lang.reflect.Method operation)
Returns the description for the specified operation.

Parameters:
operation - the operation
Returns:
a String containing the description

getOperationParameterName

public java.lang.String getOperationParameterName(java.lang.reflect.Method method,
                                                  int index)
Returns the name of the operation's parameter for the given operation and parameter index.

Parameters:
method - the method
index - the parameter index
Returns:
a String containing the parameter name

getOperationParameterDescription

public java.lang.String getOperationParameterDescription(java.lang.reflect.Method method,
                                                         int index)
Returns the description of the operation's parameter for the given operation and parameter index.

Parameters:
method - the method
index - the parameter index
Returns:
a String containing the description


Copyright © 2002, 2003 - ObjectWeb Consortium - All Rights Reserved.