org.apache.felix.mosgi.jmx.agent.mx4j
Class MBeanDescriptionAdapter

java.lang.Object
  extended by org.apache.felix.mosgi.jmx.agent.mx4j.MBeanDescriptionAdapter
All Implemented Interfaces:
MBeanDescription

public class MBeanDescriptionAdapter
extends Object
implements MBeanDescription

Default implementation for the MBeanDescription interface.

Version:
$Revision: 1.1.1.1 $
Author:
Simone Bordet

Constructor Summary
MBeanDescriptionAdapter()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBeanDescriptionAdapter

public MBeanDescriptionAdapter()
Method Detail

getMBeanDescription

public String getMBeanDescription()
Description copied from interface: MBeanDescription
Should return the description of the MBean. For example: "This MBean is the rmiregistry service"

Specified by:
getMBeanDescription in interface MBeanDescription

getConstructorDescription

public String getConstructorDescription(Constructor ctor)
Description copied from interface: MBeanDescription
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

getConstructorParameterName

public String getConstructorParameterName(Constructor ctor,
                                          int index)
Description copied from interface: MBeanDescription
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

getConstructorParameterDescription

public String getConstructorParameterDescription(Constructor ctor,
                                                 int index)
Description copied from interface: MBeanDescription
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

getAttributeDescription

public String getAttributeDescription(String attribute)
Description copied from interface: MBeanDescription
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

getOperationDescription

public String getOperationDescription(Method operation)
Description copied from interface: MBeanDescription
Should return the description for the specified operation. For example: "Binds the given object to the given name"

Specified by:
getOperationDescription in interface MBeanDescription

getOperationParameterName

public String getOperationParameterName(Method method,
                                        int index)
Description copied from interface: MBeanDescription
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

getOperationParameterDescription

public String getOperationParameterDescription(Method method,
                                               int index)
Description copied from interface: MBeanDescription
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


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.