javax.management
Class MBeanNotificationInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanNotificationInfo

Direct Known Subclasses:

ModelMBeanNotificationInfo

public class MBeanNotificationInfo

extends MBeanFeatureInfo

implements java.io.Serializable, java.lang.Cloneable

The MBeanNotificationInfo class is used to describe the characteristics of the different notification instances emitted by an MBean, for a given Java class of notification. If an MBean emits notifcations that can be instances of different Java classes, then the metadata for that MBean should provide an MBeanNotificationInfo object for each of these notification Java classes.

Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

This class extends javax.management.MBeanFeatureInfo and thus provides name and description fields. The name field should be the fully qualified Java class name of the notification objects described by this class.

The getNotifTypes method returns an array of strings containing the notification types that the MBean may emit. The notification type is a dot-notation string which describes what the emitted notification is about, not the Java class of the notification. A single generic notification class can be used to send notifications of several types. All of these types are returned in the string array result of the getNotifTypes method.

See Also:

Serialized Form

Field Summary

(package private) static MBeanNotificationInfo[]	NO_NOTIFICATIONS
(package private) static long	serialVersionUID

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

Constructor Summary

MBeanNotificationInfo(java.lang.String[] notifTypes, java.lang.String name, java.lang.String description)
Constructs an MBeanNotificationInfo object.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj) Compare this MBeanAttributeInfo to another.
java.lang.String[]	getNotifTypes() Returns the array of strings (in dot notation) containing the notification types that the MBean may emit.
int	hashCode() Returns the hash code value for this instance.
java.lang.String	toString() Returns a human readable version of the MBeanNotificationInfo instance.

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getName

Methods inherited from class java.lang.Object

, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_NOTIFICATIONS

static final MBeanNotificationInfo[] NO_NOTIFICATIONS

serialVersionUID

static final long serialVersionUID

Constructor Detail

MBeanNotificationInfo

public MBeanNotificationInfo(java.lang.String[] notifTypes,
                             java.lang.String name,
                             java.lang.String description)
                      throws java.lang.IllegalArgumentException

Constructs an MBeanNotificationInfo object.

Parameters:

notifTypes - The array of strings (in dot notation) containing the notification types that the MBean may emit. This may be null with the same effect as a zero-length array.

name - The fully qualified Java class name of described notifications.

description - A human readable description of the data.

Throws:

java.lang.IllegalArgumentException - if name is not a valid Java class name. Java reserved words are not considered illegal here.

Method Detail

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A duplicate copy of this object is created

getNotifTypes

public java.lang.String[] getNotifTypes()

Returns the array of strings (in dot notation) containing the notification types that the MBean may emit.

Returns:

the array of strings. Changing the returned array has no effect on this MBeanNotificationInfo.

equals

public boolean equals(java.lang.Object obj)

Compare this MBeanAttributeInfo to another.

Overrides:

equals in class MBeanFeatureInfo

Parameters:

o - the object to compare to.

Returns:

true iff o is an MBeanNotificationInfo such that its MBeanFeatureInfo.getName(), MBeanFeatureInfo.getDescription(), and getNotifTypes() values are equal (not necessarily identical) to those of this MBeanNotificationInfo. Two notification type arrays are equal if their corresponding elements are equal. They are not equal if they have the same elements but in a different order.

hashCode

public int hashCode()

Returns the hash code value for this instance.

Overrides:

hashCode in class MBeanFeatureInfo

Returns:

hashCode for this instance

toString

public java.lang.String toString()

Returns a human readable version of the MBeanNotificationInfo instance.

Overrides:

toString in class MBeanFeatureInfo

Returns:

MBeanNotificationInfo of String type is returned