Eclipse Platform
Release 3.1

org.eclipse.core.runtime.preferences
Class IEclipsePreferences.PreferenceChangeEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byorg.eclipse.core.runtime.preferences.IEclipsePreferences.PreferenceChangeEvent
All Implemented Interfaces:
Serializable
Enclosing class:
IEclipsePreferences

public static final class IEclipsePreferences.PreferenceChangeEvent
extends EventObject

An event object describing the details of a change to a preference in the preference store.

Since:
3.0
See Also:
IEclipsePreferences.IPreferenceChangeListener, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
IEclipsePreferences.PreferenceChangeEvent(Object node, String key, Object oldValue, Object newValue)
          Constructor for a new preference change event.
 
Method Summary
 String getKey()
          Return the key of the preference which was changed.
 Object getNewValue()
          Return the new value for the preference encoded as a String, or null if the preference was removed.
 Preferences getNode()
          Return the preference node on which the change occurred.
 Object getOldValue()
          Return the old value for the preference encoded as a String, or null if the preference was removed or if it cannot be determined.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IEclipsePreferences.PreferenceChangeEvent

public IEclipsePreferences.PreferenceChangeEvent(Object node,
                                                 String key,
                                                 Object oldValue,
                                                 Object newValue)
Constructor for a new preference change event. The node and the key must not be null. The old and new preference values must be either a String or null.

Parameters:
node - the node on which the change occurred
key - the preference key
oldValue - the old preference value, as a String or null
newValue - the new preference value, as a String or null
Method Detail

getNode

public Preferences getNode()
Return the preference node on which the change occurred. Must not be null.

Returns:
the node

getKey

public String getKey()
Return the key of the preference which was changed. Must not be null.

Returns:
the preference key

getNewValue

public Object getNewValue()
Return the new value for the preference encoded as a String, or null if the preference was removed.

Returns:
the new value or null

getOldValue

public Object getOldValue()
Return the old value for the preference encoded as a String, or null if the preference was removed or if it cannot be determined.

Returns:
the old value or null

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.