Java™ Platform
Standard Ed. 6

javax.management
Class MBeanNotificationInfo

java.lang.Object
  extended by javax.management.MBeanFeatureInfo
      extended by javax.management.MBeanNotificationInfo
All Implemented Interfaces:
Serializable, Cloneable, DescriptorRead
Direct Known Subclasses:
ModelMBeanNotificationInfo

public class MBeanNotificationInfo
extends MBeanFeatureInfo
implements 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 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 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.

Since:
1.5
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
 
Constructor Summary
MBeanNotificationInfo(String[] notifTypes, String name, String description)
          Constructs an MBeanNotificationInfo object.
MBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor)
          Constructs an MBeanNotificationInfo object.
 
Method Summary
 Object clone()
          Returns a shallow clone of this instance.
 boolean equals(Object o)
          Compare this MBeanNotificationInfo 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.
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MBeanNotificationInfo

public MBeanNotificationInfo(String[] notifTypes,
                             String name,
                             String description)
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 the described notifications.
description - A human readable description of the data.

MBeanNotificationInfo

public MBeanNotificationInfo(String[] notifTypes,
                             String name,
                             String description,
                             Descriptor descriptor)
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 the described notifications.
description - A human readable description of the data.
descriptor - The descriptor for the notifications. This may be null which is equivalent to an empty descriptor.
Since:
1.6
Method Detail

clone

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.

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

getNotifTypes

public 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.

toString

public String toString()
Description copied from class: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:
toString in class Object
Returns:
a string representation of the object.

equals

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

Overrides:
equals in class MBeanFeatureInfo
Parameters:
o - the object to compare to.
Returns:
true if and only if o is an MBeanNotificationInfo such that its MBeanFeatureInfo.getName(), MBeanFeatureInfo.getDescription(), MBeanFeatureInfo.getDescriptor(), 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

hashCode

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.)

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

Java™ Platform
Standard Ed. 6

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

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.