OpenJDK 27 · javax.management.openmbean.OpenMBeanInfo

Describes an Open MBean: an Open MBean is recognized as such if its getMBeanInfo() method returns an instance of a class which implements the OpenMBeanInfo interface, typically OpenMBeanInfoSupport.

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

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

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the specified object is equal to this `OpenMBeanInfo` instance. equals(Object the object to be compared for equality with this `OpenMBeanInfo` instance; obj) Compares the specified `obj` parameter with this `OpenMBeanInfo` instance for equality.
public MBeanAttributeInfo[]	Returns: the attribute array. getAttributes() Returns an array of `OpenMBeanAttributeInfo` instances describing each attribute in the open MBean described by this `OpenMBeanInfo` instance.
public String	Returns: the class name. getClassName() Returns the fully qualified Java class name of the open MBean instances this `OpenMBeanInfo` describes.
public MBeanConstructorInfo[]	Returns: the constructor array. getConstructors() Returns an array of `OpenMBeanConstructorInfo` instances describing each constructor in the open MBean described by this `OpenMBeanInfo` instance.
public String	Returns: the description. getDescription() Returns a human readable description of the type of open MBean instances this `OpenMBeanInfo` describes.
public MBeanNotificationInfo[]	Returns: the notification array. getNotifications() Returns an array of `MBeanNotificationInfo` instances describing each notification emitted by the open MBean described by this `OpenMBeanInfo` instance.
public MBeanOperationInfo[]	Returns: the operation array. getOperations() Returns an array of `OpenMBeanOperationInfo` instances describing each operation in the open MBean described by this `OpenMBeanInfo` instance.
public int	Returns: the hash code value for this `OpenMBeanInfo` instance hashCode() Returns the hash code value for this `OpenMBeanInfo` instance.
public String	Returns: a string representation of this `OpenMBeanInfo` instance toString() Returns a string representation of this `OpenMBeanInfo` instance.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(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: `obj` is non null, `obj` also implements the `OpenMBeanInfo` interface, their class names are equal their infos on attributes, constructors, operations and notifications are equal This ensures that this `equals` method works properly for `obj` parameters which are different implementations of the `OpenMBeanInfo` interface. Parameters obj:Object the object to be compared for equality with this `OpenMBeanInfo` instance; Returns:boolean `true` if the specified object is equal to this `OpenMBeanInfo` instance.

public boolean equals(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:

obj is non null,
obj also implements the OpenMBeanInfo interface,
their class names are equal
their infos on attributes, constructors, operations and notifications are equal

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

Parameters

obj:Object: the object to be compared for equality with this OpenMBeanInfo instance;

Returns:boolean

true if the specified object is equal to this OpenMBeanInfo instance.

getAttributes back to summary

getAttributes	back to summary
public 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`). Returns:MBeanAttributeInfo[] the attribute array.

public 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).

Returns:MBeanAttributeInfo[]: the attribute array.

getClassName back to summary

getClassName	back to summary
public String getClassName() Returns the fully qualified Java class name of the open MBean instances this `OpenMBeanInfo` describes. Returns:String the class name.

public String getClassName()

Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes.

Returns:String: the class name.

getConstructors back to summary

getConstructors	back to summary
public 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`). Returns:MBeanConstructorInfo[] the constructor array.

public 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).

Returns:MBeanConstructorInfo[]: the constructor array.

getDescription back to summary

getDescription	back to summary
public String getDescription() Returns a human readable description of the type of open MBean instances this `OpenMBeanInfo` describes. Returns:String the description.

public String getDescription()

Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes.

Returns:String: the description.

getNotifications back to summary

getNotifications	back to summary
public MBeanNotificationInfo[] getNotifications() Returns an array of `MBeanNotificationInfo` instances describing each notification emitted by the open MBean described by this `OpenMBeanInfo` instance. Returns:MBeanNotificationInfo[] the notification array.

public MBeanNotificationInfo[] getNotifications()

Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance.

Returns:MBeanNotificationInfo[]: the notification array.

getOperations back to summary

getOperations	back to summary
public 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`). Returns:MBeanOperationInfo[] the operation array.

public 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).

Returns:MBeanOperationInfo[]: the operation array.

hashCode back to summary

hashCode	back to summary
public 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()`. Returns:int the hash code value for this `OpenMBeanInfo` instance

public 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().

Returns:int: the hash code value for this OpenMBeanInfo instance

toString back to summary

toString	back to summary
public 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. Returns:String a string representation of this `OpenMBeanInfo` instance

public 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.

Returns:String: a string representation of this OpenMBeanInfo instance

public Interface OpenMBeanInfo

Method Summary

Method Detail