javax.management.openmbean

Interface OpenMBeanInfo

public interface OpenMBeanInfo

Describes an open management bean. Open management beans are management beans where {@link javax.management.DynamicMBean#getMBeanInfo()} returns an implementation of this interface. This interface includes those methods specified by {@link javax.management.MBeanInfo}, so implementations should extend this class. Each method which returns an array of one of the MBeanXXXInfo classes should return an array containing instances of the equivalent open version (OpenMBeanXXXInfo).

Since: 1.5

Method Summary
boolean	equals(Object obj) Compares this attribute with the supplied object.
MBeanAttributeInfo[]	getAttributes() Returns descriptions of each of the attributes provided by this management bean.
String	getClassName() Returns the class name of the management bean.
MBeanConstructorInfo[]	getConstructors() Returns descriptions of each of the constructors provided by this management bean.
String	getDescription() Returns a description of this operation.
MBeanNotificationInfo[]	getNotifications() Returns descriptions of each of the notifications provided by this management bean.
MBeanOperationInfo[]	getOperations() Returns descriptions of each of the operations provided by this management bean.
int	hashCode() Returns the hashcode of the bean information as the sum of the hashcodes of the class name and each array (calculated using java.util.HashSet(`java.util.Arrays.asList(signature)).hashCode()`).
String	toString() Returns a textual representation of this instance.

Method Detail

equals

public boolean equals(Object obj)

Compares this attribute with the supplied object. This returns true iff the object is an instance of {@link OpenMBeanInfo} with the same class name and equal instances of the info classes.

Parameters: obj the object to compare.

Returns: true if the object is a {@link OpenMBeanInfo} instance, className.equals(object.getClassName()) and each info class has an equal in the other object.

getAttributes

public MBeanAttributeInfo[] getAttributes()

Returns descriptions of each of the attributes provided by this management bean. The elements should be implementations of the {@link OpenMBeanAttributeInfo} class.

Returns: an array of {@link OpenMBeanAttributeInfo} objects, representing the attributes emitted by this management bean.

getClassName

public String getClassName()

Returns the class name of the management bean.

Returns: the bean's class name.

getConstructors

public MBeanConstructorInfo[] getConstructors()

Returns descriptions of each of the constructors provided by this management bean. The elements should be implementations of the {@link OpenMBeanConstructorInfo} class.

Returns: an array of {@link OpenMBeanConstructorInfo} objects, representing the constructors emitted by this management bean.

getDescription

public String getDescription()

Returns a description of this operation.

Returns: a human-readable description.

getNotifications

public MBeanNotificationInfo[] getNotifications()

Returns descriptions of each of the notifications provided by this management bean. The elements should be implementations of the {@link OpenMBeanNotificationInfo} class.

Returns: an array of {@link OpenMBeanNotificationInfo} objects, representing the notifications emitted by this management bean.

getOperations

public MBeanOperationInfo[] getOperations()

Returns descriptions of each of the operations provided by this management bean. The elements should be implementations of the {@link OpenMBeanOperationInfo} class.

Returns: an array of {@link OpenMBeanOperationInfo} objects, representing the operations emitted by this management bean.

hashCode

public int hashCode()

Returns the hashcode of the bean information as the sum of the hashcodes of the class name and each array (calculated using java.util.HashSet(java.util.Arrays.asList(signature)).hashCode()).

Returns: the hashcode of the bean information.

toString

public String toString()

Returns a textual representation of this instance. This is constructed using the class name (javax.management.openmbean.OpenMBeanInfo) along with the class name and textual representations of each array.

Returns: a @link{java.lang.String} instance representing the instance in textual form.