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()
Returns a hash code value for the object.
|
String |
toString()
Returns a string representation of the object.
|
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
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())
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()
,
HashMap
public int hashCode()
Object
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
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
Java™ programming language.)
hashCode
in class MBeanFeatureInfo
Object.equals(java.lang.Object)
,
System.identityHashCode(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, 2024, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.