javax.management

Class MBeanNotificationInfo

Implemented Interfaces:
Cloneable, Serializable

public class MBeanNotificationInfo
extends MBeanFeatureInfo
implements Cloneable

Describes the notifications emitted by a management bean. An instance of this class is specific to notifications involving a particular type of object. A new instance should be created for each Java class used for notifications, and the Java class name forms the name of the instance. Each instance lists a number of notification types; these are not types in the sense of different Java classes, but instead form the names of notifications following the same syntax as Java property and package names.

For instance, a management bean may emit two notifications containing String objects. Both would be described using one instance of this class, with a member of the array returned by getNotifTypes() for each one. If another notification containing a Date object were to be added, this would require a new instance of this class.

The information in this class is immutable as standard. Of course, subclasses may change this, but this behaviour is not recommended.

Since:
1.5
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

Constructor Summary

MBeanNotificationInfo(String[] types, String name, String description)
Constructs a new MBeanNotificationInfo with the specified name, description and notification types.

Method Summary

Object
clone()
Returns a clone of this instance.
boolean
equals(Object obj)
Compares this feature with the supplied object.
String[]
getNotifTypes()
Returns the notification types that the management bean may emit.
int
hashCode()
Returns the hashcode of the notification information as the sum of the hashcode of the superclass and the hashcode of the types array.
String
toString()
Returns a textual representation of this instance.

Methods inherited from class javax.management.MBeanFeatureInfo

equals, getDescription, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MBeanNotificationInfo

public MBeanNotificationInfo(String[] types,
                             String name,
                             String description)
Constructs a new MBeanNotificationInfo with the specified name, description and notification types. The notification types array may be null or of zero length, in order to indicate the absence of any types.
Parameters:
types - an array of String objects, containing the names of the notifications emitted of this Java type. The names use the dot notation familiar from Java property and package names.
name - the name of the Java class the notifications described by this object are instances of.
description - a description of the data.
Throws:
IllegalArgumentException - for some reason...

Method Details

clone

public Object clone()
Returns a clone of this instance. The clone is created using just the method provided by Object. Thus, the clone is just a shallow clone as returned by that method, and does not contain any deeper cloning based on the subject of this class.
Overrides:
clone in interface Object
Returns:
a clone of this instance.
See Also:
Cloneable

equals

public boolean equals(Object obj)
Compares this feature with the supplied object. This returns true iff the object is an instance of MBeanNotificationInfo, Object.equals() returns true for a comparison of both the name and description of this notification with that of the specified object, and the two notification type arrays contain the same elements in the same order (but one may be longer than the other).
Overrides:
equals in interface MBeanFeatureInfo
Parameters:
obj - the object to compare.
Returns:
true if the object is a MBeanNotificationInfo instance, name.equals(object.getName()), description.equals(object.getDescription()) and the corresponding elements of the type arrays are equal.

getNotifTypes

public String[] getNotifTypes()
Returns the notification types that the management bean may emit. The notification types are strings using the dot notation familiar from Java property and package names. Changing the returned array does not affect the values retained by this instance.
Returns:
the notification types.

hashCode

public int hashCode()
Returns the hashcode of the notification information as the sum of the hashcode of the superclass and the hashcode of the types array.
Overrides:
hashCode in interface MBeanFeatureInfo
Returns:
the hashcode of the notification information.

toString

public String toString()
Returns a textual representation of this instance. This is constructed using the class name (javax.management.MBeanNotificationInfo), the name and description of the notification and the contents of the array of types.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Overrides:
toString in interface MBeanFeatureInfo
Returns:
a @link{java.lang.String} instance representing the instance in textual form.

MBeanNotificationInfo.java -- Information about a bean's notification. Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.