javax.management.openmbean
Interface OpenMBeanInfo

All Known Implementing Classes:
OpenMBeanInfoSupport sample code for javax.management.openmbean.OpenMBeanInfoSupport definition code for javax.management.openmbean.OpenMBeanInfoSupport

public interface OpenMBeanInfo

Describes an Open MBean: an Open MBean is recognized as such if its getMBeanInfo() sample code for javax.management.DynamicMBean.getMBeanInfo() definition code for javax.management.DynamicMBean.getMBeanInfo() method returns an instance of a class which implements the OpenMBeanInfo sample code for javax.management.openmbean.OpenMBeanInfo definition code for javax.management.openmbean.OpenMBeanInfo interface, typically OpenMBeanInfoSupport sample code for javax.management.openmbean.OpenMBeanInfoSupport definition code for javax.management.openmbean.OpenMBeanInfoSupport .

This interface declares the same methods as the class MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo . A class implementing this interface (typically OpenMBeanInfoSupport sample code for javax.management.openmbean.OpenMBeanInfoSupport definition code for javax.management.openmbean.OpenMBeanInfoSupport ) should extend MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo .

The getAttributes() sample code for javax.management.openmbean.OpenMBeanInfo.getAttributes() definition code for javax.management.openmbean.OpenMBeanInfo.getAttributes() , getOperations() sample code for javax.management.openmbean.OpenMBeanInfo.getOperations() definition code for javax.management.openmbean.OpenMBeanInfo.getOperations() and getConstructors() sample code for javax.management.openmbean.OpenMBeanInfo.getConstructors() definition code for javax.management.openmbean.OpenMBeanInfo.getConstructors() methods of the implementing class should return at runtime an array of instances of a subclass of MBeanAttributeInfo sample code for javax.management.MBeanAttributeInfo definition code for javax.management.MBeanAttributeInfo , MBeanOperationInfo sample code for javax.management.MBeanOperationInfo definition code for javax.management.MBeanOperationInfo or MBeanConstructorInfo sample code for javax.management.MBeanConstructorInfo definition code for javax.management.MBeanConstructorInfo respectively which implement the OpenMBeanAttributeInfo sample code for javax.management.openmbean.OpenMBeanAttributeInfo definition code for javax.management.openmbean.OpenMBeanAttributeInfo , OpenMBeanOperationInfo sample code for javax.management.openmbean.OpenMBeanOperationInfo definition code for javax.management.openmbean.OpenMBeanOperationInfo or OpenMBeanConstructorInfo sample code for javax.management.openmbean.OpenMBeanConstructorInfo definition code for javax.management.openmbean.OpenMBeanConstructorInfo interface respectively.

Since:
1.5

Method Summary
 boolean equals sample code for javax.management.openmbean.OpenMBeanInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanInfo.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares the specified obj parameter with this OpenMBeanInfo instance for equality.
 MBeanAttributeInfo sample code for javax.management.MBeanAttributeInfo definition code for javax.management.MBeanAttributeInfo [] getAttributes sample code for javax.management.openmbean.OpenMBeanInfo.getAttributes() definition code for javax.management.openmbean.OpenMBeanInfo.getAttributes() ()
          Returns an array of OpenMBeanAttributeInfo instances describing each attribute in the open MBean described by this OpenMBeanInfo instance.
 String sample code for java.lang.String definition code for java.lang.String getClassName sample code for javax.management.openmbean.OpenMBeanInfo.getClassName() definition code for javax.management.openmbean.OpenMBeanInfo.getClassName() ()
          Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes.
 MBeanConstructorInfo sample code for javax.management.MBeanConstructorInfo definition code for javax.management.MBeanConstructorInfo [] getConstructors sample code for javax.management.openmbean.OpenMBeanInfo.getConstructors() definition code for javax.management.openmbean.OpenMBeanInfo.getConstructors() ()
          Returns an array of OpenMBeanConstructorInfo instances describing each constructor in the open MBean described by this OpenMBeanInfo instance.
 String sample code for java.lang.String definition code for java.lang.String getDescription sample code for javax.management.openmbean.OpenMBeanInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanInfo.getDescription() ()
          Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes.
 MBeanNotificationInfo sample code for javax.management.MBeanNotificationInfo definition code for javax.management.MBeanNotificationInfo [] getNotifications sample code for javax.management.openmbean.OpenMBeanInfo.getNotifications() definition code for javax.management.openmbean.OpenMBeanInfo.getNotifications() ()
          Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance.
 MBeanOperationInfo sample code for javax.management.MBeanOperationInfo definition code for javax.management.MBeanOperationInfo [] getOperations sample code for javax.management.openmbean.OpenMBeanInfo.getOperations() definition code for javax.management.openmbean.OpenMBeanInfo.getOperations() ()
          Returns an array of OpenMBeanOperationInfo instances describing each operation in the open MBean described by this OpenMBeanInfo instance.
 int hashCode sample code for javax.management.openmbean.OpenMBeanInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanInfo.hashCode() ()
          Returns the hash code value for this OpenMBeanInfo instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.OpenMBeanInfo.toString() definition code for javax.management.openmbean.OpenMBeanInfo.toString() ()
          Returns a string representation of this OpenMBeanInfo instance.
 

Method Detail

getClassName sample code for javax.management.openmbean.OpenMBeanInfo.getClassName() definition code for javax.management.openmbean.OpenMBeanInfo.getClassName()

String sample code for java.lang.String definition code for java.lang.String  getClassName()
Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes.

Returns:
the class name.

getDescription sample code for javax.management.openmbean.OpenMBeanInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanInfo.getDescription()

String sample code for java.lang.String definition code for java.lang.String  getDescription()
Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes.

Returns:
the description.

getAttributes sample code for javax.management.openmbean.OpenMBeanInfo.getAttributes() definition code for javax.management.openmbean.OpenMBeanInfo.getAttributes()

MBeanAttributeInfo sample code for javax.management.MBeanAttributeInfo definition code for javax.management.MBeanAttributeInfo [] getAttributes()
Returns an array of OpenMBeanAttributeInfo instances describing each attribute in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanAttributeInfo which implements the OpenMBeanAttributeInfo interface (typically OpenMBeanAttributeInfoSupport sample code for javax.management.openmbean.OpenMBeanAttributeInfoSupport definition code for javax.management.openmbean.OpenMBeanAttributeInfoSupport ).

Returns:
the attribute array.

getOperations sample code for javax.management.openmbean.OpenMBeanInfo.getOperations() definition code for javax.management.openmbean.OpenMBeanInfo.getOperations()

MBeanOperationInfo sample code for javax.management.MBeanOperationInfo definition code for javax.management.MBeanOperationInfo [] getOperations()
Returns an array of OpenMBeanOperationInfo instances describing each operation in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanOperationInfo which implements the OpenMBeanOperationInfo interface (typically OpenMBeanOperationInfoSupport sample code for javax.management.openmbean.OpenMBeanOperationInfoSupport definition code for javax.management.openmbean.OpenMBeanOperationInfoSupport ).

Returns:
the operation array.

getConstructors sample code for javax.management.openmbean.OpenMBeanInfo.getConstructors() definition code for javax.management.openmbean.OpenMBeanInfo.getConstructors()

MBeanConstructorInfo sample code for javax.management.MBeanConstructorInfo definition code for javax.management.MBeanConstructorInfo [] getConstructors()
Returns an array of OpenMBeanConstructorInfo instances describing each constructor in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanConstructorInfo which implements the OpenMBeanConstructorInfo interface (typically OpenMBeanConstructorInfoSupport sample code for javax.management.openmbean.OpenMBeanConstructorInfoSupport definition code for javax.management.openmbean.OpenMBeanConstructorInfoSupport ).

Returns:
the constructor array.

getNotifications sample code for javax.management.openmbean.OpenMBeanInfo.getNotifications() definition code for javax.management.openmbean.OpenMBeanInfo.getNotifications()

MBeanNotificationInfo sample code for javax.management.MBeanNotificationInfo definition code for javax.management.MBeanNotificationInfo [] getNotifications()
Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance.

Returns:
the notification array.

equals sample code for javax.management.openmbean.OpenMBeanInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanInfo.equals(java.lang.Object)

boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
Compares the specified obj parameter with this OpenMBeanInfo instance for equality.

Returns true if and only if all of the following statements are true:

This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanInfo interface.
 

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the object to be compared for equality with this OpenMBeanInfo instance;
Returns:
true if the specified object is equal to this OpenMBeanInfo instance.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.openmbean.OpenMBeanInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanInfo.hashCode()

int hashCode()
Returns the hash code value for this OpenMBeanInfo instance.

The hash code of an OpenMBeanInfo instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: its class name, and its infos on attributes, constructors, operations and notifications, where the hashCode of each of these arrays is calculated by a call to new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()).

This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two OpenMBeanInfo instances t1 and t2, as required by the general contract of the method Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() .

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hash code value for this OpenMBeanInfo instance
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.management.openmbean.OpenMBeanInfo.toString() definition code for javax.management.openmbean.OpenMBeanInfo.toString()

String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of this OpenMBeanInfo instance.

The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanInfo), the MBean class name, and the string representation of infos on attributes, constructors, operations and notifications of the described MBean.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this OpenMBeanInfo instance