OpenJDK 1.23 · javax.management.MBeanNotificationInfo

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.

Field Summary

Modifier and Type	Field and Description
private final transient boolean	arrayGettersSafe
pack-priv static final MBeanNotificationInfo[]	NO_NOTIFICATIONS
private static final String[]	NO_TYPES
pack-priv static final long	serialVersionUID Hides javax.management.MBeanFeatureInfo.serialVersionUID.
private String[]	types

Inherited from javax.management.MBeanFeatureInfo:: description name

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	MBeanNotificationInfo(String[] 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. notifTypes, String The fully qualified Java class name of the described notifications. name, String A human readable description of the data. description) Constructs an `MBeanNotificationInfo` object.
public	MBeanNotificationInfo(String[] 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. notifTypes, String The fully qualified Java class name of the described notifications. name, String A human readable description of the data. description, Descriptor The descriptor for the notifications. This may be null which is equivalent to an empty descriptor. descriptor) Constructs an `MBeanNotificationInfo` object.

public

MBeanNotificationInfo(String[]

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.

notifTypes, String

The fully qualified Java class name of the described notifications.

name, String

A human readable description of the data.

description)

Constructs an MBeanNotificationInfo object.

public

MBeanNotificationInfo(String[]

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.

notifTypes, String

The fully qualified Java class name of the described notifications.

name, String

A human readable description of the data.

description, Descriptor

The descriptor for the notifications. This may be null which is equivalent to an empty descriptor.

descriptor)

Constructs an MBeanNotificationInfo object.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Returns a shallow clone of this instance.
public boolean	Returns: true if and only if `o` is an MBeanNotificationInfo such that its `getName()`, `getDescription()`, `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. equals(Object the object to compare to. o) Overrides javax.management.MBeanFeatureInfo.equals. Compare this MBeanNotificationInfo to another.
private String[]	fastGetNotifTypes()
public String[]	Returns: the array of strings. Changing the returned array has no effect on this MBeanNotificationInfo. getNotifTypes() Returns the array of strings (in dot notation) containing the notification types that the MBean may emit.
public int	hashCode() Overrides javax.management.MBeanFeatureInfo.hashCode. Returns a hash code value for this object.
private void	readObject(ObjectInputStream ois) Hides javax.management.MBeanFeatureInfo.readObject. Deserializes an `MBeanFeatureInfo` from an `ObjectInputStream`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from javax.management.MBeanFeatureInfo:: getDescription getDescriptor getName

Field Detail

arrayGettersSafe	back to summary
private final transient boolean arrayGettersSafe See Also `MBeanInfo#arrayGettersSafe`

NO_NOTIFICATIONS	back to summary
pack-priv static final MBeanNotificationInfo[] NO_NOTIFICATIONS

NO_TYPES	back to summary
private static final String[] NO_TYPES

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides javax.management.MBeanFeatureInfo.serialVersionUID.

types	back to summary
private String[] types

Constructor Detail

MBeanNotificationInfo back to summary

MBeanNotificationInfo	back to summary
public MBeanNotificationInfo(String[] notifTypes, String name, String description) Constructs an `MBeanNotificationInfo` object. Parameters notifTypes:String[] 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:String The fully qualified Java class name of the described notifications. description:String A human readable description of the data.

public MBeanNotificationInfo(String[] notifTypes, String name, String description)

Constructs an MBeanNotificationInfo object.

Parameters

notifTypes:String[]: 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:String: The fully qualified Java class name of the described notifications.
description:String: A human readable description of the data.

MBeanNotificationInfo back to summary

MBeanNotificationInfo	back to summary
public MBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor) Constructs an `MBeanNotificationInfo` object. Parameters notifTypes:String[] 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:String The fully qualified Java class name of the described notifications. description:String A human readable description of the data. descriptor:Descriptor The descriptor for the notifications. This may be null which is equivalent to an empty descriptor. Since 1.6

public MBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor)

Constructs an MBeanNotificationInfo object.

Parameters

notifTypes:String[]: 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:String: The fully qualified Java class name of the described notifications.
description:String: A human readable description of the data.
descriptor:Descriptor: The descriptor for the notifications. This may be null which is equivalent to an empty descriptor.

Since

1.6

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.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. Returns:Object Doc from java.lang.Object.clone. a clone of this instance.

public Object clone()

Overrides java.lang.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.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides javax.management.MBeanFeatureInfo.equals. Compare this MBeanNotificationInfo to another. Parameters o:Object the object to compare to. Returns:boolean true if and only if `o` is an MBeanNotificationInfo such that its `getName()`, `getDescription()`, `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.

public boolean equals(Object o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanNotificationInfo to another.

Parameters

o:Object: the object to compare to.

Returns:boolean

true if and only if o is an MBeanNotificationInfo such that its getName(), getDescription(), 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.

fastGetNotifTypes	back to summary
private String[] fastGetNotifTypes()

getNotifTypes	back to summary
public String[] getNotifTypes() Returns the array of strings (in dot notation) containing the notification types that the MBean may emit. Returns:String[] the array of strings. Changing the returned array has no effect on this MBeanNotificationInfo.

getNotifTypes

back to summary

public String[] getNotifTypes()

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

Returns:String[]: the array of strings. Changing the returned array has no effect on this MBeanNotificationInfo.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides javax.management.MBeanFeatureInfo.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `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. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` 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. Returns:int a hash code value for this object

public int hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the 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.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals 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.

Returns:int: a hash code value for this object

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException Hides javax.management.MBeanFeatureInfo.readObject. Doc from javax.management.MBeanFeatureInfo.readObject. Deserializes an `MBeanFeatureInfo` from an `ObjectInputStream`.

private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException

Hides javax.management.MBeanFeatureInfo.readObject.

Doc from javax.management.MBeanFeatureInfo.readObject.

Deserializes an MBeanFeatureInfo from an ObjectInputStream.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public Class MBeanNotificationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail