org.eclipse.core.internal.preferences

Class RootPreferences

java.lang.Object

org.eclipse.core.internal.preferences.EclipsePreferences

org.eclipse.core.internal.preferences.RootPreferences

All Implemented Interfaces:

IEclipsePreferences, IScope, Preferences

public class RootPreferences
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 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
RootPreferences() Default constructor.

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	getChild(java.lang.String key, java.lang.Object context)
protected IEclipsePreferences[]	getChildren()
Preferences	getNode(java.lang.String path, boolean create)
Preferences	node(java.lang.String path) Return the preferences node with the given path.
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, getLoadLevel, getLocation, getLong, getSegment, getSegmentCount, internalChildNames, internalCreate, internalFlush, internalGet, internalNode, internalPut, isAlreadyLoaded, isDirty, isLoading, keys, load, load, loaded, loadLegacy, loadProperties, log, makeDirty, makeRelative, name, nodeExists, 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

Constructor Detail

RootPreferences

public RootPreferences()

Default constructor.

Method Detail

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

Overrides:

flush in class EclipsePreferences

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()

getChild

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

getChildren

protected IEclipsePreferences[] getChildren()

node

public Preferences node(java.lang.String path)

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

Overrides:

node in class EclipsePreferences

Parameters:

path - the path of the node

Returns:

the node

See Also:

Preferences.node(String), IEclipsePreferences.NodeChangeEvent

getNode

public Preferences getNode(java.lang.String path,
                           boolean create)

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

Overrides:

sync in class EclipsePreferences

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()