001/* AttributeChangeNotification.java -- Notification for attribute changes
002   Copyright (C) 2007 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.management;
040
041/**
042 * Defines the notification used to let listeners know of
043 * an attribute change.  The bean itself is responsible
044 * for creating and transmitting the notification when the
045 * attribute changes, by implementing
046 * {@link NotificationBroadcaster}.  For example, if a
047 * bean increments the integer, <code>count</code>, it
048 * should send a notification with the
049 * <code>attributeName</code>, <code>"count"</code>,
050 * the <code>attributeType</code>, <code>"Integer"</code>
051 * and the old and new values of the attribute.
052 *
053 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
054 * @since 1.5
055 */
056public class AttributeChangeNotification
057  extends Notification
058{
059
060  /**
061   * Compatible with JDK 1.5
062   */
063  private static final long serialVersionUID = 535176054565814134L;
064
065  /**
066   * The attribute type for attribute change
067   * notifications.
068   */
069  public static final String ATTRIBUTE_CHANGE = "jmx.attribute.change";
070
071  /**
072   * The name of the attribute that changed.
073   */
074  private String attributeName;
075
076  /**
077   * The type of the attribute that changed.
078   */
079  private String attributeType;
080
081  /**
082   * The old value of the attribute.
083   */
084  private Object oldValue;
085
086  /**
087   * The new value of the attribute.
088   */
089  private Object newValue;
090
091  /**
092   * Constructs a new {@link AttributeChangeNotification}
093   * with the specified source, sequence number, timestamp,
094   * message, and the attribute name, type, old value and
095   * new value.
096   *
097   * @param source the producer of the notification, which
098   *               is usually the bean that changed the
099   *               attribute.
100   * @param sequenceNumber the sequence number of the
101   *                       notification.
102   * @param timeStamp the date and time of the notification.
103   * @param msg the message content of the notification.
104   * @param name the name of the attribute.
105   * @param type the type of the attribute.
106   * @param oldVal the old value of the attribute.
107   * @param newVal the new value of the attribute.
108   */
109  public AttributeChangeNotification(Object source,
110                                     long sequenceNumber,
111                                     long timeStamp,
112                                     String msg, String name,
113                                     String type, Object oldVal,
114                                     Object newVal)
115  {
116    super(ATTRIBUTE_CHANGE, source, sequenceNumber,
117          timeStamp, msg);
118    attributeName = name;
119    attributeType = type;
120    oldValue = oldVal;
121    newValue = newVal;
122  }
123
124  /**
125   * Returns the name of the attribute that changed.
126   *
127   * @return the name of the attribute.
128   */
129  public String getAttributeName()
130  {
131    return attributeName;
132  }
133
134  /**
135   * Returns the type of the attribute that changed.
136   *
137   * @return the type of the attribute.
138   */
139  public String getAttributeType()
140  {
141    return attributeType;
142  }
143
144  /**
145   * Returns the old value of the attribute.
146   *
147   * @return the old value.
148   */
149  public Object getOldValue()
150  {
151    return oldValue;
152  }
153
154  /**
155   * Returns the new value of the attribute.
156   *
157   * @return the new value.
158   */
159  public Object getNewValue()
160  {
161    return newValue;
162  }
163
164}