-
- All Known Implementing Classes:
OpenMBeanInfoSupport
public interface OpenMBeanInfoDescribes an Open MBean: an Open MBean is recognized as such if its
getMBeanInfo()method returns an instance of a class which implements theOpenMBeanInfointerface, typicallyOpenMBeanInfoSupport.This interface declares the same methods as the class
MBeanInfo. A class implementing this interface (typicallyOpenMBeanInfoSupport) should extendMBeanInfo.The
getAttributes(),getOperations()andgetConstructors()methods of the implementing class should return at runtime an array of instances of a subclass ofMBeanAttributeInfo,MBeanOperationInfoorMBeanConstructorInforespectively which implement theOpenMBeanAttributeInfo,OpenMBeanOperationInfoorOpenMBeanConstructorInfointerface respectively.- Since:
- 1.5
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specified obj parameter with thisOpenMBeanInfoinstance for equality.MBeanAttributeInfo[]getAttributes()Returns an array ofOpenMBeanAttributeInfoinstances describing each attribute in the open MBean described by thisOpenMBeanInfoinstance.StringgetClassName()Returns the fully qualified Java class name of the open MBean instances thisOpenMBeanInfodescribes.MBeanConstructorInfo[]getConstructors()Returns an array ofOpenMBeanConstructorInfoinstances describing each constructor in the open MBean described by thisOpenMBeanInfoinstance.StringgetDescription()Returns a human readable description of the type of open MBean instances thisOpenMBeanInfodescribes.MBeanNotificationInfo[]getNotifications()Returns an array ofMBeanNotificationInfoinstances describing each notification emitted by the open MBean described by thisOpenMBeanInfoinstance.MBeanOperationInfo[]getOperations()Returns an array ofOpenMBeanOperationInfoinstances describing each operation in the open MBean described by thisOpenMBeanInfoinstance.inthashCode()Returns the hash code value for thisOpenMBeanInfoinstance.StringtoString()Returns a string representation of thisOpenMBeanInfoinstance.
-
-
-
Method Detail
-
getClassName
String getClassName()
Returns the fully qualified Java class name of the open MBean instances thisOpenMBeanInfodescribes.- Returns:
- the class name.
-
getDescription
String getDescription()
Returns a human readable description of the type of open MBean instances thisOpenMBeanInfodescribes.- Returns:
- the description.
-
getAttributes
MBeanAttributeInfo[] getAttributes()
Returns an array ofOpenMBeanAttributeInfoinstances describing each attribute in the open MBean described by thisOpenMBeanInfoinstance. Each instance in the returned array should actually be a subclass ofMBeanAttributeInfowhich implements theOpenMBeanAttributeInfointerface (typicallyOpenMBeanAttributeInfoSupport).- Returns:
- the attribute array.
-
getOperations
MBeanOperationInfo[] getOperations()
Returns an array ofOpenMBeanOperationInfoinstances describing each operation in the open MBean described by thisOpenMBeanInfoinstance. Each instance in the returned array should actually be a subclass ofMBeanOperationInfowhich implements theOpenMBeanOperationInfointerface (typicallyOpenMBeanOperationInfoSupport).- Returns:
- the operation array.
-
getConstructors
MBeanConstructorInfo[] getConstructors()
Returns an array ofOpenMBeanConstructorInfoinstances describing each constructor in the open MBean described by thisOpenMBeanInfoinstance. Each instance in the returned array should actually be a subclass ofMBeanConstructorInfowhich implements theOpenMBeanConstructorInfointerface (typicallyOpenMBeanConstructorInfoSupport).- Returns:
- the constructor array.
-
getNotifications
MBeanNotificationInfo[] getNotifications()
Returns an array ofMBeanNotificationInfoinstances describing each notification emitted by the open MBean described by thisOpenMBeanInfoinstance.- Returns:
- the notification array.
-
equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanInfoinstance for equality.Returns
trueif and only if all of the following statements are true:- obj is non null,
- obj also implements the
OpenMBeanInfointerface, - their class names are equal
- their infos on attributes, constructors, operations and notifications are equal
equalsmethod works properly for obj parameters which are different implementations of theOpenMBeanInfointerface.- Overrides:
equalsin classObject- Parameters:
obj- the object to be compared for equality with thisOpenMBeanInfoinstance;- Returns:
trueif the specified object is equal to thisOpenMBeanInfoinstance.- See Also:
Object.hashCode()
-
hashCode
int hashCode()
Returns the hash code value for thisOpenMBeanInfoinstance.The hash code of an
OpenMBeanInfoinstance is the sum of the hash codes of all elements of information used inequalscomparisons (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 twoOpenMBeanInfoinstancest1andt2, as required by the general contract of the methodObject.hashCode().- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanInfoinstance - See Also:
Object.equals(java.lang.Object)
-
toString
String toString()
Returns a string representation of thisOpenMBeanInfoinstance.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.
-
-