This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management.openmbean
interface OpenMBeanInfo

All Known Implementing Classes:
OpenMBeanInfoSupport

public interface OpenMBeanInfo

Describes an Open MBean: an Open MBean is recognized as such if its {@link javax.management.DynamicMBean#getMBeanInfo() getMBeanInfo()} method returns an instance of a class which implements the {@link OpenMBeanInfo} interface, typically {@link OpenMBeanInfoSupport}.

This interface declares the same methods as the class {@link javax.management.MBeanInfo}. A class implementing this interface (typically {@link OpenMBeanInfoSupport}) should extend {@link javax.management.MBeanInfo}.

The {@link #getAttributes()}, {@link #getOperations()} and {@link #getConstructors()} methods of the implementing class should return at runtime an array of instances of a subclass of {@link MBeanAttributeInfo}, {@link MBeanOperationInfo} or {@link MBeanConstructorInfo} respectively which implement the {@link OpenMBeanAttributeInfo}, {@link OpenMBeanOperationInfo} or {@link OpenMBeanConstructorInfo} interface respectively.


Method Summary
 boolean

          Compares the specified obj parameter with this OpenMBeanInfo instance for equality.
 MBeanAttributeInfo[]

          Returns an array of OpenMBeanAttributeInfo instances describing each attribute in the open MBean described by this OpenMBeanInfo instance.
 String

          Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes.
 MBeanConstructorInfo[]

          Returns an array of OpenMBeanConstructorInfo instances describing each constructor in the open MBean described by this OpenMBeanInfo instance.
 String

          Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes.
 MBeanNotificationInfo[]

          Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance.
 MBeanOperationInfo[]

          Returns an array of OpenMBeanOperationInfo instances describing each operation in the open MBean described by this OpenMBeanInfo instance.
 int

          Returns the hash code value for this OpenMBeanInfo instance.
 String

          Returns a string representation of this OpenMBeanInfo instance.
 

Method Detail

equals

public boolean equals(Object obj)
Compares the specified obj parameter with this OpenMBeanInfo instance for equality.

Returns true if and only if all of the following statements are true:

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

Overrides:
equals in class Object
Parameters:
obj - the object to be compared for equality with this OpenMBeanInfo instance;
Returns:
true if the specified object is equal to this OpenMBeanInfo instance.

getAttributes

public MBeanAttributeInfo[] getAttributes()
Returns an array of OpenMBeanAttributeInfo instances describing each attribute in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanAttributeInfo which implements the OpenMBeanAttributeInfo interface (typically {@link OpenMBeanAttributeInfoSupport}).

Returns:
the attribute array.

getClassName

public String getClassName()
Returns the fully qualified Java class name of the open MBean instances this OpenMBeanInfo describes.

Returns:
the class name.

getConstructors

public MBeanConstructorInfo[] getConstructors()
Returns an array of OpenMBeanConstructorInfo instances describing each constructor in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanConstructorInfo which implements the OpenMBeanConstructorInfo interface (typically {@link OpenMBeanConstructorInfoSupport}).

Returns:
the constructor array.

getDescription

public String getDescription()
Returns a human readable description of the type of open MBean instances this OpenMBeanInfo describes.

Returns:
the description.

getNotifications

public MBeanNotificationInfo[] getNotifications()
Returns an array of MBeanNotificationInfo instances describing each notification emitted by the open MBean described by this OpenMBeanInfo instance.

Returns:
the notification array.

getOperations

public MBeanOperationInfo[] getOperations()
Returns an array of OpenMBeanOperationInfo instances describing each operation in the open MBean described by this OpenMBeanInfo instance. Each instance in the returned array should actually be a subclass of MBeanOperationInfo which implements the OpenMBeanOperationInfo interface (typically {@link OpenMBeanOperationInfoSupport}).

Returns:
the operation array.

hashCode

public int hashCode()
Returns the hash code value for this OpenMBeanInfo instance.

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

Overrides:
hashCode in class Object
Returns:
the hash code value for this OpenMBeanInfo instance

toString

public String toString()
Returns a string representation of this OpenMBeanInfo 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.

Overrides:
toString in class Object
Returns:
a string representation of this OpenMBeanInfo instance


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.