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.
description, name
Constructor and Description |
---|
MBeanNotificationInfo(String[] notifTypes,
String name,
String description)
Constructs an
MBeanNotificationInfo object. |
MBeanNotificationInfo(String[] notifTypes,
String name,
String description,
Descriptor descriptor)
Constructs an
MBeanNotificationInfo object. |
Modifier and Type | Method and Description |
---|---|
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()
Answers an integer hash code for the receiver.
|
String |
toString()
Answers a string containing a concise, human-readable
description of the receiver.
|
getDescription, getDescriptor, getName
public MBeanNotificationInfo(String[] notifTypes, String name, String description)
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.public MBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor)
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.descriptor
- The descriptor for the notifications. This may be null
which is equivalent to an empty descriptor.public Object clone()
public String[] getNotifTypes()
public String toString()
Object
public boolean equals(Object o)
equals
in class MBeanFeatureInfo
o
- the object to compare to.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.Object.hashCode()
public int hashCode()
Object
true
when passed to
.equals
must answer the same value for this
method.hashCode
in class MBeanFeatureInfo
Object.equals(java.lang.Object)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.