org.jboss.mx.mxbean
Class MXBeanMetaData

java.lang.Object
  org.jboss.mx.metadata.AbstractBuilder
      org.jboss.mx.mxbean.MXBeanMetaData

All Implemented Interfaces:

MetaDataBuilder

public class MXBeanMetaData
extends AbstractBuilder

MXBeanMetaData

Author:

Juha Lindfors., Trevor Squires., Thomas Diesler., Dimitris Andreadis.

Field Summary

Fields inherited from class org.jboss.mx.metadata.AbstractBuilder

properties

Constructor Summary

MXBeanMetaData(Class<?> mbeanClass)
Create a new MXBeanMetaData.

MXBeanMetaData(Object mbeanInstance)
Create a new MXBeanMetaData.

MXBeanMetaData(Object mbeanInstance, Class<?> mbeanInterface)
Create a new MXBeanMetaData.

Method Summary

MBeanInfo	build() Constructs the Model MBean metadata.
static Class<?>	findMXBeanInterface(Class<?> mbeanClass) Find the MXBean interface for a class
Class<?>	getMBeanInterface() Retrieve the management interface

Methods inherited from class org.jboss.mx.metadata.AbstractBuilder

getBooleanProperty, getProperties, getProperty, getStringProperty, setProperties, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MXBeanMetaData

public MXBeanMetaData(Object mbeanInstance)
               throws NotCompliantMBeanException

Create a new MXBeanMetaData.

Parameters:

mbeanInstance - the mbean instance

Throws:

NotCompliantMBeanException - for any error

MXBeanMetaData

public MXBeanMetaData(Class<?> mbeanClass)
               throws NotCompliantMBeanException

Create a new MXBeanMetaData.

Parameters:

mbeanClass - the class

Throws:

NotCompliantMBeanException - for any error

MXBeanMetaData

public MXBeanMetaData(Object mbeanInstance,
                      Class<?> mbeanInterface)
               throws NotCompliantMBeanException

Create a new MXBeanMetaData.

Parameters:

mbeanInstance - the mbean instance

mbeanInterface - the mbean interface

Throws:

NotCompliantMBeanException - for any error

Method Detail

findMXBeanInterface

public static Class<?> findMXBeanInterface(Class<?> mbeanClass)

Find the MXBean interface for a class

Parameters:

mbeanClass - the mbean class

Returns:

the interface

getMBeanInterface

public Class<?> getMBeanInterface()

Retrieve the management interface

Returns:

the interface

build

public MBeanInfo build()
                throws NotCompliantMBeanException

Description copied from interface: MetaDataBuilder

Constructs the Model MBean metadata.

Specified by:

build in interface MetaDataBuilder

Specified by:

build in class AbstractBuilder

Returns:

initialized MBean info

Throws:

NotCompliantMBeanException - if there were errors building the MBean info from the given data source