org.eclipse.core.internal.preferences

Class DefaultPreferences

java.lang.Object

org.eclipse.core.internal.preferences.EclipsePreferences

org.eclipse.core.internal.preferences.DefaultPreferences

All Implemented Interfaces:

IEclipsePreferences, IScope, Preferences

public class DefaultPreferences
extends EclipsePreferences

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
static java.lang.String	pluginCustomizationFile

Fields inherited from class org.eclipse.core.internal.preferences.EclipsePreferences

children, DEBUG_PREFERENCE_GENERAL, DEBUG_PREFERENCE_GET, DEBUG_PREFERENCE_SET, debugPluginName, DEFAULT_PREFERENCES_DIRNAME, dirty, DOUBLE_SLASH, EMPTY_NODE_ARRAY, EMPTY_STRING, EMPTY_STRING_ARRAY, loading, name, parent, PATH_SEPARATOR, PREFS_FILE_EXTENSION, properties, removed, VERSION_KEY, VERSION_VALUE

Constructor Summary

Constructors

Constructor and Description
DefaultPreferences() Default constructor for this class.

Method Summary

Modifier and Type	Method and Description
void	flush() Forces any changes in the contents of this node and its descendants to the persistent store.
protected IEclipsePreferences	getLoadLevel()
protected static java.lang.String	getScopeRelativePath(java.lang.String absolutePath)
protected EclipsePreferences	internalCreate(EclipsePreferences nodeParent, java.lang.String nodeName, java.lang.Object context)
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)
protected void	load() Loads the preference node.
protected void	loaded()
IEclipsePreferences	node(java.lang.String childName, java.lang.Object context)
boolean	nodeExists(java.lang.String path) Returns true if the named node exists.
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.

Methods inherited from class org.eclipse.core.internal.preferences.EclipsePreferences

absolutePath, accept, addChild, addNodeChangeListener, addPreferenceChangeListener, checkRemoved, childExists, childrenNames, clear, computeChildren, computeLocation, convertFromProperties, convertToProperties, create, create, decodePath, encodePath, fireNodeEvent, firePreferenceEvent, get, getBoolean, getByteArray, getChild, getChildren, getDouble, getFloat, getInt, getLocation, getLong, getSegment, getSegmentCount, internalChildNames, internalFlush, internalGet, internalNode, isDirty, isLoading, keys, load, loadLegacy, log, makeDirty, makeRelative, name, node, parent, put, putBoolean, putByteArray, putDouble, putFloat, putInt, putLong, remove, removeNode, removeNode, removeNode, removeNodeChangeListener, removePreferenceChangeListener, removeTimestampFromTable, save, save, setLoading, shareStrings, toDeepDebugString, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

pluginCustomizationFile

public static java.lang.String pluginCustomizationFile

Constructor Detail

DefaultPreferences

public DefaultPreferences()

Default constructor for this class.

Method Detail

node

public IEclipsePreferences node(java.lang.String childName,
                                java.lang.Object context)

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

Overrides:

nodeExists in class EclipsePreferences

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.

flush

public void flush()

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

Overrides:

flush in class EclipsePreferences

See Also:

Preferences.sync()

getLoadLevel

protected IEclipsePreferences getLoadLevel()

Overrides:

getLoadLevel in class EclipsePreferences

internalCreate

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

Overrides:

internalCreate in class EclipsePreferences

isAlreadyLoaded

protected boolean isAlreadyLoaded(IEclipsePreferences node)

Overrides:

isAlreadyLoaded in class EclipsePreferences

load

protected void load()

Description copied from class: EclipsePreferences

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

Overrides:

load in class EclipsePreferences

internalPut

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

Description copied from class: EclipsePreferences

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.

Overrides:

internalPut in class EclipsePreferences

getScopeRelativePath

protected static java.lang.String getScopeRelativePath(java.lang.String absolutePath)

loaded

protected void loaded()

Overrides:

loaded in class EclipsePreferences

sync

public void sync()

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

Overrides:

sync in class EclipsePreferences

See Also:

Preferences.flush()