javax.management.openmbean
class OpenMBeanInfoSupport

java.lang.Object javax.management.MBeanInfo javax.management.openmbean.OpenMBeanInfoSupport

All Implemented Interfaces:

Serializable, Cloneable, DescriptorRead, OpenMBeanInfo

public class OpenMBeanInfoSupport
extends MBeanInfo
implements OpenMBeanInfo

The {@code OpenMBeanInfoSupport} class describes the management information of an open MBean: it is a subclass of {@link javax.management.MBeanInfo}, and it implements the {@link OpenMBeanInfo} interface. Note that an open MBean is recognized as such if its {@code getMBeanInfo()} method returns an instance of a class which implements the OpenMBeanInfo interface, typically {@code OpenMBeanInfoSupport}.

OpenMBeanInfoSupport

public OpenMBeanInfoSupport(String className,
                            String description,
                            OpenMBeanAttributeInfo[] openAttributes,
                            OpenMBeanConstructorInfo[] openConstructors,
                            OpenMBeanOperationInfo[] openOperations,
                            MBeanNotificationInfo[] notifications)

Constructs an {@code OpenMBeanInfoSupport} instance, which describes a class of open MBeans with the specified {@code className}, {@code description}, {@code openAttributes}, {@code openConstructors} , {@code openOperations} and {@code notifications}.

The {@code openAttributes}, {@code openConstructors}, {@code openOperations} and {@code notifications} array parameters are internally copied, so that subsequent changes to the arrays referenced by these parameters have no effect on this instance.

Parameters:

className - The fully qualified Java class name of the open MBean described by this OpenMBeanInfoSupport instance.

description - A human readable description of the open MBean described by this OpenMBeanInfoSupport instance.

openAttributes - The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of {@code MBeanAttributeInfo}, typically {@code OpenMBeanAttributeInfoSupport}.

openConstructors - The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of {@code MBeanConstructorInfo}, typically {@code OpenMBeanConstructorInfoSupport}.

openOperations - The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of {@code MBeanOperationInfo}, typically {@code OpenMBeanOperationInfoSupport}.

notifications - The list of notifications emitted by the described open MBean.

OpenMBeanInfoSupport

public OpenMBeanInfoSupport(String className,
                            String description,
                            OpenMBeanAttributeInfo[] openAttributes,
                            OpenMBeanConstructorInfo[] openConstructors,
                            OpenMBeanOperationInfo[] openOperations,
                            MBeanNotificationInfo[] notifications,
                            Descriptor descriptor)

Constructs an {@code OpenMBeanInfoSupport} instance, which describes a class of open MBeans with the specified {@code className}, {@code description}, {@code openAttributes}, {@code openConstructors} , {@code openOperations}, {@code notifications}, and {@code descriptor}.

The {@code openAttributes}, {@code openConstructors}, {@code openOperations} and {@code notifications} array parameters are internally copied, so that subsequent changes to the arrays referenced by these parameters have no effect on this instance.

Parameters:

className - The fully qualified Java class name of the open MBean described by this OpenMBeanInfoSupport instance.

description - A human readable description of the open MBean described by this OpenMBeanInfoSupport instance.

openAttributes - The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of {@code MBeanAttributeInfo}, typically {@code OpenMBeanAttributeInfoSupport}.

openConstructors - The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of {@code MBeanConstructorInfo}, typically {@code OpenMBeanConstructorInfoSupport}.

openOperations - The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of {@code MBeanOperationInfo}, typically {@code OpenMBeanOperationInfoSupport}.

notifications - The list of notifications emitted by the described open MBean.

descriptor - The descriptor for the MBean. This may be null which is equivalent to an empty descriptor.

equals

public boolean equals(Object obj)

Compares the specified {@code obj} parameter with this {@code OpenMBeanInfoSupport} instance for equality.

Returns {@code true} if and only if all of the following statements are true:

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

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

Overrides:

equals in class MBeanInfo

Parameters:

obj - the object to be compared for equality with this {@code OpenMBeanInfoSupport} instance;

Returns:

{@code true} if the specified object is equal to this {@code OpenMBeanInfoSupport} instance.

hashCode

public int hashCode()

Returns the hash code value for this {@code OpenMBeanInfoSupport} instance.

The hash code of an {@code OpenMBeanInfoSupport} instance is the sum of the hash codes of all elements of information used in {@code 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 {@code new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()}).

This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()} for any two {@code OpenMBeanInfoSupport} instances {@code t1} and {@code t2}, as required by the general contract of the method {@link Object#hashCode() Object.hashCode()}.

However, note that another instance of a class implementing the {@code OpenMBeanInfo} interface may be equal to this {@code OpenMBeanInfoSupport} instance as defined by {@link #equals(java.lang.Object)}, but may have a different hash code if it is calculated differently.

As {@code OpenMBeanInfoSupport} instances are immutable, the hash code for this instance is calculated once, on the first call to {@code hashCode}, and then the same value is returned for subsequent calls.

Overrides:

hashCode in class MBeanInfo

Returns:

the hash code value for this {@code OpenMBeanInfoSupport} instance

toString

public String toString()

Returns a string representation of this {@code OpenMBeanInfoSupport} instance.

The string representation consists of the name of this class (ie {@code javax.management.openmbean.OpenMBeanInfoSupport}), the MBean class name, the string representation of infos on attributes, constructors, operations and notifications of the described MBean and the string representation of the descriptor.

As {@code OpenMBeanInfoSupport} instances are immutable, the string representation for this instance is calculated once, on the first call to {@code toString}, and then the same value is returned for subsequent calls.

Overrides:

toString in class MBeanInfo

Returns:

a string representation of this {@code OpenMBeanInfoSupport} instance