- All Known Implementing Classes:
OpenMBeanInfoSupport
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 MBeanInfo
. A class implementing this interface
(typically OpenMBeanInfoSupport
) should extend 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.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified obj parameter with thisOpenMBeanInfo
instance for equality.Returns an array ofOpenMBeanAttributeInfo
instances describing each attribute in the open MBean described by thisOpenMBeanInfo
instance.Returns the fully qualified Java class name of the open MBean instances thisOpenMBeanInfo
describes.Returns an array ofOpenMBeanConstructorInfo
instances describing each constructor in the open MBean described by thisOpenMBeanInfo
instance.Returns a human readable description of the type of open MBean instances thisOpenMBeanInfo
describes.Returns an array ofMBeanNotificationInfo
instances describing each notification emitted by the open MBean described by thisOpenMBeanInfo
instance.Returns an array ofOpenMBeanOperationInfo
instances describing each operation in the open MBean described by thisOpenMBeanInfo
instance.int
hashCode()
Returns the hash code value for thisOpenMBeanInfo
instance.toString()
Returns a string representation of thisOpenMBeanInfo
instance.
-
Method Details
-
getClassName
String getClassName()Returns the fully qualified Java class name of the open MBean instances thisOpenMBeanInfo
describes.- Returns:
- the class name.
-
getDescription
String getDescription()Returns a human readable description of the type of open MBean instances thisOpenMBeanInfo
describes.- Returns:
- the description.
-
getAttributes
MBeanAttributeInfo[] getAttributes()Returns an array ofOpenMBeanAttributeInfo
instances describing each attribute in the open MBean described by thisOpenMBeanInfo
instance. Each instance in the returned array should actually be a subclass ofMBeanAttributeInfo
which implements theOpenMBeanAttributeInfo
interface (typicallyOpenMBeanAttributeInfoSupport
).- Returns:
- the attribute array.
-
getOperations
MBeanOperationInfo[] getOperations()Returns an array ofOpenMBeanOperationInfo
instances describing each operation in the open MBean described by thisOpenMBeanInfo
instance. Each instance in the returned array should actually be a subclass ofMBeanOperationInfo
which implements theOpenMBeanOperationInfo
interface (typicallyOpenMBeanOperationInfoSupport
).- Returns:
- the operation array.
-
getConstructors
MBeanConstructorInfo[] getConstructors()Returns an array ofOpenMBeanConstructorInfo
instances describing each constructor in the open MBean described by thisOpenMBeanInfo
instance. Each instance in the returned array should actually be a subclass ofMBeanConstructorInfo
which implements theOpenMBeanConstructorInfo
interface (typicallyOpenMBeanConstructorInfoSupport
).- Returns:
- the constructor array.
-
getNotifications
MBeanNotificationInfo[] getNotifications()Returns an array ofMBeanNotificationInfo
instances describing each notification emitted by the open MBean described by thisOpenMBeanInfo
instance.- Returns:
- the notification array.
-
equals
Compares the specified obj parameter with thisOpenMBeanInfo
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
equals
method works properly for obj parameters which are different implementations of theOpenMBeanInfo
interface. -
hashCode
int hashCode()Returns the hash code value for thisOpenMBeanInfo
instance.The hash code of an
OpenMBeanInfo
instance is the sum of the hash codes of all elements of information used inequals
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 tonew java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()
).This ensures that
t1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoOpenMBeanInfo
instancest1
andt2
, as required by the general contract of the methodObject.hashCode()
. -
toString
String toString()Returns a string representation of thisOpenMBeanInfo
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.
-