JavaTM 2 Platform
Standard Ed. 5.0
Class MBeanNotificationInfo

  extended by
      extended by
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:

public class MBeanNotificationInfo
extends MBeanFeatureInfo
implements Cloneable, Serializable

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 notifications 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 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
Fields inherited from class
description, name
Constructor Summary
MBeanNotificationInfo(String[] notifTypes, String name, String description)
          Constructs an MBeanNotificationInfo object.
Method Summary
 Object clone()
          Returns a shallow clone of this instance.
 boolean equals(Object o)
          Compare this MBeanAttributeInfo to another.
 String[] getNotifTypes()
          Returns the array of strings (in dot notation) containing the notification types that the MBean may emit.
 int hashCode()
          Returns a hash code value for the object.
Methods inherited from class
getDescription, getName
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public MBeanNotificationInfo(String[] notifTypes,
                             String name,
                             String description)
                      throws IllegalArgumentException
Constructs an MBeanNotificationInfo object.

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 the described notifications.
description - A human readable description of the data.
Method Detail


public Object clone()
Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

clone in class Object
a clone of this instance.
See Also:


public String[] getNotifTypes()
Returns the array of strings (in dot notation) containing the notification types that the MBean may emit.

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


public boolean equals(Object o)
Compare this MBeanAttributeInfo to another.

equals in class MBeanFeatureInfo
o - the object to compare to.
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.
See Also:
Object.hashCode(), Hashtable


public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

hashCode in class MBeanFeatureInfo
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.