libjava/classpath/javax/management/AttributeChangeNotification.java

   1 /* AttributeChangeNotification.java -- Notification for attribute changes
   2    Copyright (C) 2007 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.management;
  40
  41 /**
  42  * Defines the notification used to let listeners know of
  43  * an attribute change.  The bean itself is responsible
  44  * for creating and transmitting the notification when the
  45  * attribute changes, by implementing
  46  * {@link NotificationBroadcaster}.  For example, if a
  47  * bean increments the integer, <code>count</code>, it
  48  * should send a notification with the
  49  * <code>attributeName</code>, <code>"count"</code>,
  50  * the <code>attributeType</code>, <code>"Integer"</code>
  51  * and the old and new values of the attribute.
  52  *
  53  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  54  * @since 1.5
  55  */
  56 public class AttributeChangeNotification
  57   extends Notification
  58 {
  59
  60   /**
  61    * Compatible with JDK 1.5
  62    */
  63   private static final long serialVersionUID = 535176054565814134L;
  64
  65   /**
  66    * The attribute type for attribute change
  67    * notifications.
  68    */
  69   public static final String ATTRIBUTE_CHANGE = "jmx.attribute.change";
  70
  71   /**
  72    * The name of the attribute that changed.
  73    */
  74   private String attributeName;
  75
  76   /**
  77    * The type of the attribute that changed.
  78    */
  79   private String attributeType;
  80
  81   /**
  82    * The old value of the attribute.
  83    */
  84   private Object oldValue;
  85
  86   /**
  87    * The new value of the attribute.
  88    */
  89   private Object newValue;
  90
  91   /**
  92    * Constructs a new {@link AttributeChangeNotification}
  93    * with the specified source, sequence number, timestamp,
  94    * message, and the attribute name, type, old value and
  95    * new value.
  96    *
  97    * @param source the producer of the notification, which
  98    *               is usually the bean that changed the
  99    *               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 }
 165
 166