gomp-20050608-branch/libjava/classpath/java/util/prefs/PreferenceChangeEvent.java

   1 /* PreferenceChangeEvent - ObjectEvent fired when a Preferences entry changes
   2    Copyright (C) 2001 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 package java.util.prefs;
  39
  40 import java.util.EventObject;
  41
  42 /**
  43  * ObjectEvent fired when a Preferences entry changes.
  44  * This event is generated when a entry is added, changed or removed.
  45  * When an entry is removed then <code>getNewValue</code> will return null.
  46  * <p>
  47  * Preference change events are only generated for entries in one particular
  48  * preference node. Notification of subnode addition/removal is given by a
  49  * <code>NodeChangeEvent</code>.
  50  *
  51  * @since 1.4
  52  * @author Mark Wielaard (mark@klomp.org)
  53  */
  54 public class PreferenceChangeEvent extends EventObject {
  55
  56   private static final long serialVersionUID = 793724513368024975L;
  57
  58     /**
  59      * The key of the changed entry.
  60      */
  61     private final String key;
  62
  63     /**
  64      * The new value of the changed entry, or null when the entry was removed.
  65      */
  66     private final String newValue;
  67
  68     /**
  69      * Creates a new PreferenceChangeEvent.
  70      *
  71      * @param node The source preference node for which an entry was added,
  72      * changed or removed
  73      * @param key The key of the entry that was added, changed or removed
  74      * @param value The new value of the entry that was added or changed, or
  75      * null when the entry was removed
  76      */
  77     public PreferenceChangeEvent(Preferences node, String key, String value) {
  78         super(node);
  79         this.key = key;
  80         this.newValue = value;
  81     }
  82
  83     /**
  84      * Returns the source Preference node from which an entry was added,
  85      * changed or removed.
  86      */
  87     public Preferences getNode() {
  88         return (Preferences) source;
  89     }
  90
  91     /**
  92      * Returns the key of the entry that was added, changed or removed.
  93      */
  94     public String getKey() {
  95         return key;
  96     }
  97
  98     /**
  99      * Returns the new value of the entry that was added or changed, or
 100      * returns null when the entry was removed.
 101      */
 102     public String getNewValue() {
 103         return newValue;
 104     }
 105 }