org.eclipse.core.internal.preferences

Class EclipsePreferences

java.lang.Object

org.eclipse.core.internal.preferences.EclipsePreferences

All Implemented Interfaces:

IEclipsePreferences, IScope, Preferences

Direct Known Subclasses:

BundleDefaultPreferences, ConfigurationPreferences, DefaultPreferences, ExportedPreferences, InstancePreferences, RootPreferences

public class EclipsePreferences
extends java.lang.Object
implements IEclipsePreferences, IScope

Represents a node in the Eclipse preference node hierarchy. This class is used as a default implementation/super class for those nodes which belong to scopes which are contributed by the Platform. Implementation notes: - For thread safety, we always synchronize on writeLock when writing the children or properties fields. Must ensure we don't synchronize when calling client code such as listeners.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.core.runtime.preferences.IEclipsePreferences

IEclipsePreferences.INodeChangeListener, IEclipsePreferences.IPreferenceChangeListener, IEclipsePreferences.NodeChangeEvent, IEclipsePreferences.PreferenceChangeEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	children
static boolean	DEBUG_PREFERENCE_GENERAL
static boolean	DEBUG_PREFERENCE_GET
static boolean	DEBUG_PREFERENCE_SET
protected static java.lang.String	debugPluginName
static java.lang.String	DEFAULT_PREFERENCES_DIRNAME
protected boolean	dirty
protected static java.lang.String	DOUBLE_SLASH
protected static IEclipsePreferences[]	EMPTY_NODE_ARRAY
protected static java.lang.String	EMPTY_STRING
protected static java.lang.String[]	EMPTY_STRING_ARRAY
protected boolean	loading
protected java.lang.String	name
protected EclipsePreferences	parent
protected static java.lang.String	PATH_SEPARATOR
static java.lang.String	PREFS_FILE_EXTENSION
protected ImmutableMap	properties
protected boolean	removed
protected static java.lang.String	VERSION_KEY
protected static java.lang.String	VERSION_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	EclipsePreferences()
protected	EclipsePreferences(EclipsePreferences parent, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	absolutePath() Returns this node's absolute path name.
void	accept(IPreferenceNodeVisitor visitor) Accepts the given visitor.
protected IEclipsePreferences	addChild(java.lang.String childName, IEclipsePreferences child)
void	addNodeChangeListener(IEclipsePreferences.INodeChangeListener listener) Register the given listener for changes to this node.
void	addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener listener) Register the given listener for notification of preference changes to this node.
protected void	checkRemoved()
protected boolean	childExists(java.lang.String childName)
java.lang.String[]	childrenNames() Returns the names of the children of this node.
void	clear() Removes all of the properties (key-value associations) in this node.
protected java.lang.String[]	computeChildren(IPath root)
protected IPath	computeLocation(IPath root, java.lang.String qualifier)
protected static void	convertFromProperties(EclipsePreferences node, java.util.Properties table, boolean notify)
protected java.util.Properties	convertToProperties(java.util.Properties result, java.lang.String prefix)
IEclipsePreferences	create(EclipsePreferences nodeParent, java.lang.String nodeName, java.lang.Object context)
IEclipsePreferences	create(IEclipsePreferences nodeParent, java.lang.String nodeName) Create and return a new preference node with the given parent and name.
static java.lang.String[]	decodePath(java.lang.String fullPath)
static java.lang.String	encodePath(java.lang.String path, java.lang.String key)
protected void	fireNodeEvent(IEclipsePreferences.NodeChangeEvent event, boolean added)
protected void	firePreferenceEvent(java.lang.String key, java.lang.Object oldValue, java.lang.Object newValue)
void	flush() Forces any changes in the contents of this node and its descendants to the persistent store.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Returns the value associated with the specified key in this node.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the boolean value represented by the String object associated with the specified key in this node.
byte[]	getByteArray(java.lang.String key, byte[] defaultValue) Returns the byte[] value represented by the String object associated with the specified key in this node.
protected IEclipsePreferences	getChild(java.lang.String key, java.lang.Object context, boolean create) Thread safe way to obtain a child for a given key.
protected IEclipsePreferences[]	getChildren(boolean create) Thread safe way to obtain all children of this node.
double	getDouble(java.lang.String key, double defaultValue) Returns the double value represented by the String object associated with the specified key in this node.
float	getFloat(java.lang.String key, float defaultValue) Returns the float value represented by the String object associated with the specified key in this node.
int	getInt(java.lang.String key, int defaultValue) Returns the int value represented by the String object associated with the specified key in this node.
protected IEclipsePreferences	getLoadLevel()
protected IPath	getLocation()
long	getLong(java.lang.String key, long defaultValue) Returns the long value represented by the String object associated with the specified key in this node.
static java.lang.String	getSegment(java.lang.String path, int segment)
static int	getSegmentCount(java.lang.String path)
protected java.lang.String[]	internalChildNames()
protected EclipsePreferences	internalCreate(EclipsePreferences nodeParent, java.lang.String nodeName, java.lang.Object context)
protected IEclipsePreferences	internalFlush()
protected java.lang.String	internalGet(java.lang.String key) Returns the existing value at the given key, or null if no such value exists.
protected IEclipsePreferences	internalNode(java.lang.String path, boolean notify, java.lang.Object context) Implements the node(String) method, and optionally notifies listeners.
protected java.lang.String	internalPut(java.lang.String key, java.lang.String newValue) Stores the given (key,value) pair, performing lazy initialization of the properties field if necessary.
protected boolean	isAlreadyLoaded(IEclipsePreferences node)
boolean	isDirty()
protected boolean	isLoading()
java.lang.String[]	keys() Returns all of the keys that have an associated value in this node.
protected void	load() Loads the preference node.
protected void	load(IPath location)
protected void	loaded()
protected void	loadLegacy()
protected static java.util.Properties	loadProperties(IPath location)
static void	log(IStatus status)
protected void	makeDirty()
static java.lang.String	makeRelative(java.lang.String path)
java.lang.String	name() Returns this node's name, relative to its parent.
Preferences	node(java.lang.String pathName) Return the preferences node with the given path.
boolean	nodeExists(java.lang.String path) Returns true if the named node exists.
Preferences	parent() Returns the parent of this node, or null if this is the root.
void	put(java.lang.String key, java.lang.String newValue) Associates the specified value with the specified key in this node.
void	putBoolean(java.lang.String key, boolean value) Associates a String object representing the specified boolean value with the specified key in this node.
void	putByteArray(java.lang.String key, byte[] value) Associates a String object representing the specified byte[] with the specified key in this node.
void	putDouble(java.lang.String key, double value) Associates a String object representing the specified double value with the specified key in this node.
void	putFloat(java.lang.String key, float value) Associates a String object representing the specified float value with the specified key in this node.
void	putInt(java.lang.String key, int value) Associates a String object representing the specified int value with the specified key in this node.
void	putLong(java.lang.String key, long value) Associates a String object representing the specified long value with the specified key in this node.
void	remove(java.lang.String key) Removes the value associated with the specified key in this node, if any.
void	removeNode() Remove this node from the preference hierarchy.
protected void	removeNode(IEclipsePreferences child)
protected java.lang.Object	removeNode(java.lang.String key)
void	removeNodeChangeListener(IEclipsePreferences.INodeChangeListener listener) De-register the given listener from receiving event change notifications for this node.
void	removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener listener) De-register the given listener from receiving notification of preference changes to this node.
protected static java.lang.String	removeTimestampFromTable(java.util.Properties properties)
protected void	save() Saves the preference node.
protected void	save(IPath location)
protected void	setLoading(boolean isLoading)
void	shareStrings(StringPool pool) Traverses the preference hierarchy rooted at this node, and adds all preference key and value strings to the provided pool.
void	sync() Ensures that future reads from this node and its descendants reflect any changes that were committed to the persistent store (from any VM) prior to the sync invocation.
java.lang.String	toDeepDebugString()
java.lang.String	toString()
protected static void	write(java.util.Properties properties, IPath location)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PREFERENCES_DIRNAME

public static final java.lang.String DEFAULT_PREFERENCES_DIRNAME

See Also:

Constant Field Values

PREFS_FILE_EXTENSION

public static final java.lang.String PREFS_FILE_EXTENSION

See Also:

Constant Field Values

EMPTY_NODE_ARRAY

protected static final IEclipsePreferences[] EMPTY_NODE_ARRAY

EMPTY_STRING_ARRAY

protected static final java.lang.String[] EMPTY_STRING_ARRAY

VERSION_KEY

protected static final java.lang.String VERSION_KEY

See Also:

Constant Field Values

VERSION_VALUE

protected static final java.lang.String VERSION_VALUE

See Also:

Constant Field Values

PATH_SEPARATOR

protected static final java.lang.String PATH_SEPARATOR

DOUBLE_SLASH

protected static final java.lang.String DOUBLE_SLASH

See Also:

Constant Field Values

EMPTY_STRING

protected static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

properties

protected ImmutableMap properties

children

protected java.util.Map<java.lang.String,java.lang.Object> children

dirty

protected boolean dirty

loading

protected boolean loading

name

protected final java.lang.String name

parent

protected final EclipsePreferences parent

removed

protected boolean removed

DEBUG_PREFERENCE_GENERAL

public static boolean DEBUG_PREFERENCE_GENERAL

DEBUG_PREFERENCE_SET

public static boolean DEBUG_PREFERENCE_SET

DEBUG_PREFERENCE_GET

public static boolean DEBUG_PREFERENCE_GET

debugPluginName

protected static final java.lang.String debugPluginName

See Also:

Constant Field Values

Constructor Detail

EclipsePreferences

public EclipsePreferences()

EclipsePreferences

protected EclipsePreferences(EclipsePreferences parent,
                             java.lang.String name)

Method Detail

absolutePath

public java.lang.String absolutePath()

Description copied from interface: Preferences

Returns this node's absolute path name. Note that:

• Root node - The path name of the root node is "/".
• Slash at end - Path names other than that of the root node may not end in slash ('/').
• Unusual names -"." and ".." have no special significance in path names.
• Illegal names - The only illegal path names are those that contain multiple consecutive slashes, or that end in slash and are not the root.

Specified by:

absolutePath in interface Preferences

Returns:

this node's absolute path name.

accept

public void accept(IPreferenceNodeVisitor visitor)
            throws BackingStoreException

Description copied from interface: IEclipsePreferences

Accepts the given visitor. The visitor's visit method is called with this node. If the visitor returns true, this method visits this node's children.

Specified by:

accept in interface IEclipsePreferences

Parameters:

visitor - the visitor

Throws:

BackingStoreException - if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

See Also:

IPreferenceNodeVisitor.visit(IEclipsePreferences)

addChild

protected IEclipsePreferences addChild(java.lang.String childName,
                                       IEclipsePreferences child)

addNodeChangeListener

public void addNodeChangeListener(IEclipsePreferences.INodeChangeListener listener)

Description copied from interface: IEclipsePreferences

Register the given listener for changes to this node. Duplicate calls to this method with the same listener will have no effect. The given listener argument must not be null.

Specified by:

addNodeChangeListener in interface IEclipsePreferences

Parameters:

listener - the node change listener to add

See Also:

IEclipsePreferences.removeNodeChangeListener(IEclipsePreferences.INodeChangeListener), IEclipsePreferences.INodeChangeListener

addPreferenceChangeListener

public void addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IEclipsePreferences

Register the given listener for notification of preference changes to this node. Calling this method multiple times with the same listener has no effect. The given listener argument must not be null.

Specified by:

addPreferenceChangeListener in interface IEclipsePreferences

Parameters:

listener - the preference change listener to register

See Also:

IEclipsePreferences.removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

checkRemoved

protected void checkRemoved()

childrenNames

public java.lang.String[] childrenNames()
                                 throws BackingStoreException

Description copied from interface: Preferences

Returns the names of the children of this node. (The returned array will be of size zero if this node has no children and not null!)

Specified by:

childrenNames in interface Preferences

Returns:

the names of the children of this node.

Throws:

BackingStoreException - if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

internalChildNames

protected java.lang.String[] internalChildNames()

clear

public void clear()

Description copied from interface: Preferences

Removes all of the properties (key-value associations) in this node. This call has no effect on any descendants of this node.

Specified by:

clear in interface Preferences

See Also:

Preferences.remove(String)

computeChildren

protected java.lang.String[] computeChildren(IPath root)

computeLocation

protected IPath computeLocation(IPath root,
                                java.lang.String qualifier)

convertFromProperties

protected static void convertFromProperties(EclipsePreferences node,
                                            java.util.Properties table,
                                            boolean notify)

write

protected static void write(java.util.Properties properties,
                            IPath location)
                     throws BackingStoreException

Throws:

BackingStoreException

removeTimestampFromTable

protected static java.lang.String removeTimestampFromTable(java.util.Properties properties)
                                                    throws java.io.IOException

Throws:

java.io.IOException

convertToProperties

protected java.util.Properties convertToProperties(java.util.Properties result,
                                                   java.lang.String prefix)
                                            throws BackingStoreException

Throws:

BackingStoreException

create

public IEclipsePreferences create(IEclipsePreferences nodeParent,
                                  java.lang.String nodeName)

Description copied from interface: IScope

Create and return a new preference node with the given parent and name. Must not return null. Clients are able to create a new node in memory or load the node's contents from the backing store. Neither the parent or name arguments should be null.

Implementors should note that the node might not have been added to the child list of the parent yet, and therefore might not be able to be referenced through navigation from the root node.

Specified by:

create in interface IScope

Parameters:

nodeParent - the node's parent

nodeName - the name of the node

Returns:

the new node

isLoading

protected boolean isLoading()

setLoading

protected void setLoading(boolean isLoading)

create

public IEclipsePreferences create(EclipsePreferences nodeParent,
                                  java.lang.String nodeName,
                                  java.lang.Object context)

flush

public void flush()
           throws BackingStoreException

Description copied from interface: Preferences

Forces any changes in the contents of this node and its descendants to the persistent store.

Once this method returns successfully, it is safe to assume that all changes made in the subtree rooted at this node prior to the method invocation have become permanent.

Implementations are free to flush changes into the persistent store at any time. They do not need to wait for this method to be called.

When a flush occurs on a newly created node, it is made persistent, as are any ancestors (and descendants) that have yet to be made persistent. Note however that any properties value changes in ancestors are not guaranteed to be made persistent.

Specified by:

flush in interface Preferences

Throws:

BackingStoreException - if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

See Also:

Preferences.sync()

internalFlush

protected IEclipsePreferences internalFlush()
                                     throws BackingStoreException

Throws:

BackingStoreException

get

public java.lang.String get(java.lang.String key,
                            java.lang.String defaultValue)

Description copied from interface: Preferences

Returns the value associated with the specified key in this node. Returns the specified default if there is no value associated with the key, or the backing store is inaccessible.

Specified by:

get in interface Preferences

Parameters:

key - key whose associated value is to be returned.

defaultValue - the value to be returned in the event that this node has no value associated with key or the backing store is inaccessible.

Returns:

the value associated with key, or def if no value is associated with key.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Description copied from interface: Preferences

Returns the boolean value represented by the String object associated with the specified key in this node. Valid strings are "true", which represents true, and "false", which represents false. Case is ignored, so, for example, "TRUE" and "False" are also valid. This method is intended for use in conjunction with the Preferences.putBoolean(java.lang.String, boolean) method.

Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if the associated value is something other than "true" or "false", ignoring case.

Specified by:

getBoolean in interface Preferences

Parameters:

key - key whose associated value is to be returned as a boolean.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as a boolean or the backing store is inaccessible.

Returns:

the boolean value represented by the String object associated with key in this node, or null if the associated value does not exist or cannot be interpreted as a boolean.

See Also:

Preferences.get(String,String), Preferences.putBoolean(String,boolean)

getByteArray

public byte[] getByteArray(java.lang.String key,
                           byte[] defaultValue)

Description copied from interface: Preferences

Returns the byte[] value represented by the String object associated with the specified key in this node. Valid String objects are Base64 encoded binary data, as defined in RFC 2045 , Section 6.8, with one minor change: the string must consist solely of characters from the Base64 Alphabet ; no newline characters or extraneous characters are permitted. This method is intended for use in conjunction with the Preferences.putByteArray(java.lang.String, byte[]) method.

Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if the associated value is not a valid Base64 encoded byte array (as defined above).

Specified by:

getByteArray in interface Preferences

Parameters:

key - key whose associated value is to be returned as a byte[] object.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as a byte[] type, or the backing store is inaccessible.

Returns:

the byte[] value represented by the String object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a byte[].

See Also:

Preferences.get(String,String), Preferences.putByteArray(String,byte[])

childExists

protected boolean childExists(java.lang.String childName)

getChild

protected IEclipsePreferences getChild(java.lang.String key,
                                       java.lang.Object context,
                                       boolean create)

Thread safe way to obtain a child for a given key. Returns the child that matches the given key, or null if there is no matching child.

getChildren

protected IEclipsePreferences[] getChildren(boolean create)

Thread safe way to obtain all children of this node. Never returns null.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Description copied from interface: Preferences

Returns the double value represented by the String object associated with the specified key in this node. The String object is converted to a double value as by Double.parseDouble(String). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Double.parseDouble(String) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the Preferences.putDouble(java.lang.String, double) method.

Specified by:

getDouble in interface Preferences

Parameters:

key - key whose associated value is to be returned as a double value.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as a double type or the backing store is inaccessible.

Returns:

the double value represented by the String object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a double type.

See Also:

Preferences.putDouble(String,double), Preferences.get(String,String)

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Description copied from interface: Preferences

Returns the float value represented by the String object associated with the specified key in this node. The String object is converted to a float value as by Float.parseFloat(String). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Float.parseFloat(String) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the Preferences.putFloat(java.lang.String, float) method.

Specified by:

getFloat in interface Preferences

Parameters:

key - key whose associated value is to be returned as a float value.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as a float type or the backing store is inaccessible.

Returns:

the float value represented by the string associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a float type.

See Also:

Preferences.putFloat(String,float), Preferences.get(String,String)

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Description copied from interface: Preferences

Returns the int value represented by the String object associated with the specified key in this node. The String object is converted to an int as by Integer.parseInt(String). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Integer.parseInt(String) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the Preferences.putInt(java.lang.String, int) method.

Specified by:

getInt in interface Preferences

Parameters:

key - key whose associated value is to be returned as an int.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as an int or the backing store is inaccessible.

Returns:

the int value represented by the String object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as an int type.

See Also:

Preferences.putInt(String,int), Preferences.get(String,String)

getLoadLevel

protected IEclipsePreferences getLoadLevel()

getLocation

protected IPath getLocation()

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Description copied from interface: Preferences

Returns the long value represented by the String object associated with the specified key in this node. The String object is converted to a long as by Long.parseLong(String). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Long.parseLong(String) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the Preferences.putLong(java.lang.String, long) method.

Specified by:

getLong in interface Preferences

Parameters:

key - key whose associated value is to be returned as a long value.

defaultValue - the value to be returned in the event that this node has no value associated with key or the associated value cannot be interpreted as a long type or the backing store is inaccessible.

Returns:

the long value represented by the String object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a long type.

See Also:

Preferences.putLong(String,long), Preferences.get(String,String)

internalCreate

protected EclipsePreferences internalCreate(EclipsePreferences nodeParent,
                                            java.lang.String nodeName,
                                            java.lang.Object context)

internalGet

protected java.lang.String internalGet(java.lang.String key)

Returns the existing value at the given key, or null if no such value exists.

internalNode

protected IEclipsePreferences internalNode(java.lang.String path,
                                           boolean notify,
                                           java.lang.Object context)

Implements the node(String) method, and optionally notifies listeners.

internalPut

protected java.lang.String internalPut(java.lang.String key,
                                       java.lang.String newValue)

Stores the given (key,value) pair, performing lazy initialization of the properties field if necessary. Returns the old value for the given key, or null if no value existed.

isAlreadyLoaded

protected boolean isAlreadyLoaded(IEclipsePreferences node)

keys

public java.lang.String[] keys()

Description copied from interface: Preferences

Returns all of the keys that have an associated value in this node. (The returned array will be of size zero if this node has no preferences and not null!)

Specified by:

keys in interface Preferences

Returns:

an array of the keys that have an associated value in this node.

load

protected void load()
             throws BackingStoreException

Loads the preference node. This method returns silently if the node does not exist in the backing store (for example non-existent project).

Throws:

BackingStoreException - if the node exists in the backing store but it could not be loaded

loadProperties

protected static java.util.Properties loadProperties(IPath location)
                                              throws BackingStoreException

Throws:

BackingStoreException

load

protected void load(IPath location)
             throws BackingStoreException

Throws:

BackingStoreException

loaded

protected void loaded()

loadLegacy

protected void loadLegacy()

log

public static void log(IStatus status)

makeDirty

protected void makeDirty()

isDirty

public boolean isDirty()

name

public java.lang.String name()

Description copied from interface: Preferences

Returns this node's name, relative to its parent.

Specified by:

name in interface Preferences

Returns:

this node's name, relative to its parent.

node

public Preferences node(java.lang.String pathName)

Description copied from interface: IEclipsePreferences

Return the preferences node with the given path. The given path must not be null.

See the spec of Preferences.node(String) for more details.

Note that if the node does not yet exist and is created, then the appropriate IEclipsePreferences.NodeChangeEvent must be sent to listeners who are registered at this node.

Specified by:

node in interface IEclipsePreferences

Specified by:

node in interface Preferences

Parameters:

pathName - the path of the node

Returns:

the node

See Also:

Preferences.node(String), IEclipsePreferences.NodeChangeEvent

fireNodeEvent

protected void fireNodeEvent(IEclipsePreferences.NodeChangeEvent event,
                             boolean added)

nodeExists

public boolean nodeExists(java.lang.String path)
                   throws BackingStoreException

Description copied from interface: Preferences

Returns true if the named node exists. Accepts a relative or absolute pathname. Absolute pathnames (which begin with '/') are interpreted relative to the root of this node. Relative pathnames (which begin with any character other than '/') are interpreted relative to this node itself. The pathname "" is valid, and refers to this node itself.

If this node (or an ancestor) has already been removed with the Preferences.removeNode() method, it is legal to invoke this method, but only with the pathname ""; the invocation will return false. Thus, the idiom p.nodeExists("") may be used to test whether p has been removed.

Specified by:

nodeExists in interface Preferences

Parameters:

path - the path name of the node whose existence is to be checked.

Returns:

true if the specified node exists.

Throws:

BackingStoreException - if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

parent

public Preferences parent()

Description copied from interface: Preferences

Returns the parent of this node, or null if this is the root.

Specified by:

parent in interface Preferences

Returns:

the parent of this node.

firePreferenceEvent

protected void firePreferenceEvent(java.lang.String key,
                                   java.lang.Object oldValue,
                                   java.lang.Object newValue)

put

public void put(java.lang.String key,
                java.lang.String newValue)

Description copied from interface: Preferences

Associates the specified value with the specified key in this node.

Specified by:

put in interface Preferences

Parameters:

key - key with which the specified value is to be associated.

newValue - value to be associated with the specified key.

putBoolean

public void putBoolean(java.lang.String key,
                       boolean value)

Description copied from interface: Preferences

Associates a String object representing the specified boolean value with the specified key in this node. The associated string is "true" if the value is true, and "false" if it is false. This method is intended for use in conjunction with the Preferences.getBoolean(java.lang.String, boolean) method.

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports boolean values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as a boolean (with getBoolean) or a String (with get) type.

Specified by:

putBoolean in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getBoolean(String,boolean), Preferences.get(String,String)

putByteArray

public void putByteArray(java.lang.String key,
                         byte[] value)

Description copied from interface: Preferences

Associates a String object representing the specified byte[] with the specified key in this node. The associated String object the Base64 encoding of the byte[], as defined in RFC 2045 , Section 6.8, with one minor change: the string will consist solely of characters from the Base64 Alphabet ; it will not contain any newline characters. This method is intended for use in conjunction with the Preferences.getByteArray(java.lang.String, byte[]) method.

Implementor's note: it is not necessary that the value be represented by a String type in the backing store. If the backing store supports byte[] values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as an a byte[] object (with getByteArray) or a String object (with get).

Specified by:

putByteArray in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getByteArray(String,byte[]), Preferences.get(String,String)

putDouble

public void putDouble(java.lang.String key,
                      double value)

Description copied from interface: Preferences

Associates a String object representing the specified double value with the specified key in this node. The associated String object is the one that would be returned if the double value were passed to Double.toString(double). This method is intended for use in conjunction with the Preferences.getDouble(java.lang.String, double) method

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports double values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as a double (with getDouble) or a String (with get) type.

Specified by:

putDouble in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getDouble(String,double)

putFloat

public void putFloat(java.lang.String key,
                     float value)

Description copied from interface: Preferences

Associates a String object representing the specified float value with the specified key in this node. The associated String object is the one that would be returned if the float value were passed to Float.toString(float). This method is intended for use in conjunction with the Preferences.getFloat(java.lang.String, float) method.

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports float values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as a float (with getFloat) or a String (with get) type.

Specified by:

putFloat in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getFloat(String,float)

putInt

public void putInt(java.lang.String key,
                   int value)

Description copied from interface: Preferences

Associates a String object representing the specified int value with the specified key in this node. The associated string is the one that would be returned if the int value were passed to Integer.toString(int). This method is intended for use in conjunction with Preferences.getInt(java.lang.String, int) method.

Implementor's note: it is not necessary that the property value be represented by a String object in the backing store. If the backing store supports integer values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as an int (with getInt or a String (with get) type.

Specified by:

putInt in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getInt(String,int)

putLong

public void putLong(java.lang.String key,
                    long value)

Description copied from interface: Preferences

Associates a String object representing the specified long value with the specified key in this node. The associated String object is the one that would be returned if the long value were passed to Long.toString(long). This method is intended for use in conjunction with the Preferences.getLong(java.lang.String, long) method.

Implementor's note: it is not necessary that the value be represented by a String type in the backing store. If the backing store supports long values, it is not unreasonable to use them. This implementation detail is not visible through the Preferences API, which allows the value to be read as a long (with getLong or a String (with get) type.

Specified by:

putLong in interface Preferences

Parameters:

key - key with which the string form of value is to be associated.

value - value whose string form is to be associated with key.

See Also:

Preferences.getLong(String,long)

remove

public void remove(java.lang.String key)

Description copied from interface: Preferences

Removes the value associated with the specified key in this node, if any.

Specified by:

remove in interface Preferences

Parameters:

key - key whose mapping is to be removed from this node.

See Also:

Preferences.get(String,String)

removeNode

public void removeNode()
                throws BackingStoreException

Description copied from interface: IEclipsePreferences

Remove this node from the preference hierarchy. If this node is the scope root, then do not remove this node, only remove this node's children.

Functionally equivalent to calling Preferences.removeNode(). See the spec of Preferences.removeNode() for more details.

Implementors must send the appropriate IEclipsePreferences.NodeChangeEvent to listeners who are registered on this node's parent.

When this node is removed, its associated preference and node change listeners should be removed as well.

Specified by:

removeNode in interface IEclipsePreferences

Specified by:

removeNode in interface Preferences

Throws:

BackingStoreException - if there was a problem removing this node

See Also:

Preferences.removeNode(), IEclipsePreferences.NodeChangeEvent

removeNode

protected void removeNode(IEclipsePreferences child)

removeNode

protected java.lang.Object removeNode(java.lang.String key)

removeNodeChangeListener

public void removeNodeChangeListener(IEclipsePreferences.INodeChangeListener listener)

Description copied from interface: IEclipsePreferences

De-register the given listener from receiving event change notifications for this node. Calling this method with a listener which is not registered has no effect. The given listener argument must not be null.

Specified by:

removeNodeChangeListener in interface IEclipsePreferences

Parameters:

listener - the node change listener to remove

See Also:

IEclipsePreferences.addNodeChangeListener(IEclipsePreferences.INodeChangeListener), IEclipsePreferences.INodeChangeListener

removePreferenceChangeListener

public void removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IEclipsePreferences

De-register the given listener from receiving notification of preference changes to this node. Calling this method multiple times with the same listener has no effect. The given listener argument must not be null.

Specified by:

removePreferenceChangeListener in interface IEclipsePreferences

Parameters:

listener - the preference change listener to remove

See Also:

IEclipsePreferences.addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

save

protected void save()
             throws BackingStoreException

Saves the preference node. This method returns silently if the node does not exist in the backing store (for example non-existent project)

Throws:

BackingStoreException - if the node exists in the backing store but it could not be saved

save

protected void save(IPath location)
             throws BackingStoreException

Throws:

BackingStoreException

shareStrings

public void shareStrings(StringPool pool)

Traverses the preference hierarchy rooted at this node, and adds all preference key and value strings to the provided pool. If an added string was already in the pool, all references will be replaced with the canonical copy of the string.

Parameters:

pool - The pool to share strings in

encodePath

public static java.lang.String encodePath(java.lang.String path,
                                          java.lang.String key)

getSegment

public static java.lang.String getSegment(java.lang.String path,
                                          int segment)

getSegmentCount

public static int getSegmentCount(java.lang.String path)

makeRelative

public static java.lang.String makeRelative(java.lang.String path)

decodePath

public static java.lang.String[] decodePath(java.lang.String fullPath)

sync

public void sync()
          throws BackingStoreException

Description copied from interface: Preferences

Ensures that future reads from this node and its descendants reflect any changes that were committed to the persistent store (from any VM) prior to the sync invocation. As a side-effect, forces any changes in the contents of this node and its descendants to the persistent store, as if the flush method had been invoked on this node.

Specified by:

sync in interface Preferences

Throws:

BackingStoreException - if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

See Also:

Preferences.flush()

toDeepDebugString

public java.lang.String toDeepDebugString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object