APIdia Launch Partner
Top Description Fields Constructors Methods
javax.management.openmbean

public Class OpenMBeanInfoSupport

extends MBeanInfo
implements OpenMBeanInfo
Class Inheritance
All Implemented Interfaces
javax.management.openmbean.OpenMBeanInfo
Imports
java.util.Arrays, .HashSet, .Objects, javax.management.Descriptor, .MBeanAttributeInfo, .MBeanConstructorInfo, .MBeanInfo, .MBeanNotificationInfo, .MBeanOperationInfo

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

Field Summary

Modifier and TypeField and Description
private transient Integer
private transient String
pack-priv static final long

Constructor Summary

AccessConstructor and Description
public
OpenMBeanInfoSupport(String
The fully qualified Java class name of the open MBean described by this OpenMBeanInfoSupport instance.
className
,
String
A human readable description of the open MBean described by this OpenMBeanInfoSupport instance.
description
,
OpenMBeanAttributeInfo[]
The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of MBeanAttributeInfo, typically OpenMBeanAttributeInfoSupport.
openAttributes
,
OpenMBeanConstructorInfo[]
The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of MBeanConstructorInfo, typically OpenMBeanConstructorInfoSupport.
openConstructors
,
OpenMBeanOperationInfo[]
The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of MBeanOperationInfo, typically OpenMBeanOperationInfoSupport.
openOperations
,
MBeanNotificationInfo[]
The list of notifications emitted by the described open MBean.
notifications
)

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

public
OpenMBeanInfoSupport(String
The fully qualified Java class name of the open MBean described by this OpenMBeanInfoSupport instance.
className
,
String
A human readable description of the open MBean described by this OpenMBeanInfoSupport instance.
description
,
OpenMBeanAttributeInfo[]
The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of MBeanAttributeInfo, typically OpenMBeanAttributeInfoSupport.
openAttributes
,
OpenMBeanConstructorInfo[]
The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of MBeanConstructorInfo, typically OpenMBeanConstructorInfoSupport.
openConstructors
,
OpenMBeanOperationInfo[]
The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of MBeanOperationInfo, typically OpenMBeanOperationInfoSupport.
openOperations
,
MBeanNotificationInfo[]
The list of notifications emitted by the described open MBean.
notifications
,
Descriptor
The descriptor for the MBean. This may be null which is equivalent to an empty descriptor.
descriptor
)

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

Method Summary

Modifier and TypeMethod and Description
private static <T> int
arraySetHash(T[] a)

private static MBeanAttributeInfo[]
private static MBeanConstructorInfo[]
public boolean

Returns:

true if the specified object is equal to this OpenMBeanInfoSupport instance.
equals
(Object
the object to be compared for equality with this OpenMBeanInfoSupport instance;
obj
)

Overrides javax.management.MBeanInfo.equals.

Implements javax.management.openmbean.OpenMBeanInfo.equals.

Compares the specified obj parameter with this OpenMBeanInfoSupport instance for equality.

public int

Returns:

the hash code value for this OpenMBeanInfoSupport instance
hashCode
()

Overrides javax.management.MBeanInfo.hashCode.

Implements javax.management.openmbean.OpenMBeanInfo.hashCode.

Returns the hash code value for this OpenMBeanInfoSupport instance.

private static MBeanOperationInfo[]
private static <T> boolean
sameArrayContents(T[] a1, T[] a2)

public String

Returns:

a string representation of this OpenMBeanInfoSupport instance
toString
()

Overrides javax.management.MBeanInfo.toString.

Implements javax.management.openmbean.OpenMBeanInfo.toString.

Returns a string representation of this OpenMBeanInfoSupport instance.

Inherited from javax.management.MBeanInfo:
clonegetAttributesgetClassNamegetConstructorsgetDescriptiongetDescriptorgetNotificationsgetOperations

Field Detail

myHashCodeback to summary
private transient Integer myHashCode
myToStringback to summary
private transient String myToString
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides javax.management.MBeanInfo.serialVersionUID.

Constructor Detail

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

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

The openAttributes, openConstructors, openOperations and 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:String

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

description:String

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

openAttributes:OpenMBeanAttributeInfo[]

The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of MBeanAttributeInfo, typically OpenMBeanAttributeInfoSupport.

openConstructors:OpenMBeanConstructorInfo[]

The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of MBeanConstructorInfo, typically OpenMBeanConstructorInfoSupport.

openOperations:OpenMBeanOperationInfo[]

The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of MBeanOperationInfo, typically OpenMBeanOperationInfoSupport.

notifications:MBeanNotificationInfo[]

The list of notifications emitted by the described open MBean.

Exceptions
ArrayStoreException:
If openAttributes, openConstructors or openOperations is not an array of instances of a subclass of MBeanAttributeInfo, MBeanConstructorInfo or MBeanOperationInfo respectively.
OpenMBeanInfoSupportback to summary
public OpenMBeanInfoSupport(String className, String description, OpenMBeanAttributeInfo[] openAttributes, OpenMBeanConstructorInfo[] openConstructors, OpenMBeanOperationInfo[] openOperations, MBeanNotificationInfo[] notifications, Descriptor descriptor)

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

The openAttributes, openConstructors, openOperations and 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:String

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

description:String

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

openAttributes:OpenMBeanAttributeInfo[]

The list of exposed attributes of the described open MBean; Must be an array of instances of a subclass of MBeanAttributeInfo, typically OpenMBeanAttributeInfoSupport.

openConstructors:OpenMBeanConstructorInfo[]

The list of exposed public constructors of the described open MBean; Must be an array of instances of a subclass of MBeanConstructorInfo, typically OpenMBeanConstructorInfoSupport.

openOperations:OpenMBeanOperationInfo[]

The list of exposed operations of the described open MBean. Must be an array of instances of a subclass of MBeanOperationInfo, typically OpenMBeanOperationInfoSupport.

notifications:MBeanNotificationInfo[]

The list of notifications emitted by the described open MBean.

descriptor:Descriptor

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

Exceptions
ArrayStoreException:
If openAttributes, openConstructors or openOperations is not an array of instances of a subclass of MBeanAttributeInfo, MBeanConstructorInfo or MBeanOperationInfo respectively.
Since
1.6

Method Detail

arraySetHashback to summary
private static <T> int arraySetHash(T[] a)
attributeArrayback to summary
private static MBeanAttributeInfo[] attributeArray(OpenMBeanAttributeInfo[] src)
constructorArrayback to summary
private static MBeanConstructorInfo[] constructorArray(OpenMBeanConstructorInfo[] src)
equalsback to summary
public boolean equals(Object obj)

Overrides javax.management.MBeanInfo.equals.

Implements javax.management.openmbean.OpenMBeanInfo.equals.

Compares the specified obj parameter with this OpenMBeanInfoSupport 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 OpenMBeanInfoSupport instance;

Returns:boolean

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

hashCodeback to summary
public int hashCode()

Overrides javax.management.MBeanInfo.hashCode.

Implements javax.management.openmbean.OpenMBeanInfo.hashCode.

Returns the hash code value for this OpenMBeanInfoSupport instance.

The hash code of an OpenMBeanInfoSupport 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 OpenMBeanInfoSupport instances t1 and t2, as required by the general contract of the method Object.hashCode().

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

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

Returns:int

the hash code value for this OpenMBeanInfoSupport instance

operationArrayback to summary
private static MBeanOperationInfo[] operationArray(OpenMBeanOperationInfo[] src)
sameArrayContentsback to summary
private static <T> boolean sameArrayContents(T[] a1, T[] a2)
toStringback to summary
public String toString()

Overrides javax.management.MBeanInfo.toString.

Implements javax.management.openmbean.OpenMBeanInfo.toString.

Returns a string representation of this OpenMBeanInfoSupport instance.

The string representation consists of the name of this class (ie 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 OpenMBeanInfoSupport instances are immutable, the string representation for this instance is calculated once, on the first call to toString, and then the same value is returned for subsequent calls.

Returns:String

a string representation of this OpenMBeanInfoSupport instance