OpenMBeanInfo (Java SE 15 & JDK 15) (original) (raw)
All Known Implementing Classes:
[OpenMBeanInfoSupport](OpenMBeanInfoSupport.html "class in javax.management.openmbean")
public interface OpenMBeanInfo
Since:
1.5
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object obj) | Compares the specified obj parameter with this OpenMBeanInfo instance for equality. |
MBeanAttributeInfo[] | getAttributes() | Returns an array of OpenMBeanAttributeInfo instances describing each attribute in the open MBean described by thisOpenMBeanInfo instance. |
String | getClassName() | Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes. |
MBeanConstructorInfo[] | getConstructors() | Returns an array of OpenMBeanConstructorInfo instances describing each constructor in the open MBean described by thisOpenMBeanInfo instance. |
String | getDescription() | Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes. |
MBeanNotificationInfo[] | getNotifications() | Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance. |
MBeanOperationInfo[] | getOperations() | Returns an array of OpenMBeanOperationInfo instances describing each operation in the open MBean described by thisOpenMBeanInfo instance. |
int | hashCode() | Returns the hash code value for this OpenMBeanInfo instance. |
String | toString() | Returns a string representation of this OpenMBeanInfo instance. |
Method Details
getClassName
Returns the fully qualified Java class name of the open MBean instances this
OpenMBeanInfo
describes.
Returns:
the class name.getDescription
Returns a human readable description of the type of open MBean instances this
OpenMBeanInfo
describes.
Returns:
the description.getAttributes
Returns an array of
OpenMBeanAttributeInfo
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 (typically OpenMBeanAttributeInfoSupport).
Returns:
the attribute array.getOperations
Returns an array of
OpenMBeanOperationInfo
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 (typically OpenMBeanOperationInfoSupport).
Returns:
the operation array.getConstructors
Returns an array of
OpenMBeanConstructorInfo
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 (typically OpenMBeanConstructorInfoSupport).
Returns:
the constructor array.getNotifications
Returns an array of
MBeanNotificationInfo
instances describing each notification emitted by the open MBean described by thisOpenMBeanInfo
instance.
Returns:
the notification array.equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanInfo
instance for equality.
Returnstrue
if and only if all of the following statements are true:
* obj is non null,
* obj also implements theOpenMBeanInfo
interface,
* their class names are equal
* their infos on attributes, constructors, operations and notifications are equal
This ensures that thisequals
method works properly for obj parameters which are different implementations of theOpenMBeanInfo
interface.
Overrides:
[equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Parameters:
obj
- the object to be compared for equality with thisOpenMBeanInfo
instance;
Returns:
true
if the specified object is equal to thisOpenMBeanInfo
instance.
See Also:
Object.hashCode(), HashMaphashCode
int hashCode()
Returns the hash code value for thisOpenMBeanInfo
instance.
The hash code of anOpenMBeanInfo
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 thatt1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoOpenMBeanInfo
instancest1
andt2
, as required by the general contract of the methodObject.hashCode().
Overrides:
[hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Returns:
the hash code value for thisOpenMBeanInfo
instance
See Also:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)toString
Returns a string representation of this
OpenMBeanInfo
instance.
The string representation consists of the name of this class (iejavax.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](../../../../java.base/java/lang/Object.html#toString%28%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Returns:
a string representation of thisOpenMBeanInfo
instance