org.eclipse.eavp.viz.service.preferences

Class CustomScopedPreferenceStore

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.preferences.ScopedPreferenceStore

org.eclipse.eavp.viz.service.preferences.CustomScopedPreferenceStore

All Implemented Interfaces:

org.eclipse.jface.preference.IPersistentPreferenceStore, org.eclipse.jface.preference.IPreferenceStore

public class CustomScopedPreferenceStore
extends org.eclipse.ui.preferences.ScopedPreferenceStore

This class provides a customized ScopedPreferenceStore that gives client code following options:

• Can add and remove child IEclipsePreferences nodes to the store.
• Can remove keyed values from the store.
• Can add and remove values for secure storage.

Changes to the store using any of the aforementioned features are not persisted until save() is called by the JFace preference page platform.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.jface.preference.IPreferenceStore

BOOLEAN_DEFAULT_DEFAULT, DOUBLE_DEFAULT_DEFAULT, FALSE, FLOAT_DEFAULT_DEFAULT, INT_DEFAULT_DEFAULT, LONG_DEFAULT_DEFAULT, STRING_DEFAULT_DEFAULT, TRUE

Constructor Summary

Constructors

Constructor and Description
CustomScopedPreferenceStore(java.lang.Class<?> clazz) A convenient constructor for getting a default CustomScopedPreferenceStore for a class' bundle.
CustomScopedPreferenceStore(org.eclipse.core.runtime.preferences.IScopeContext context, java.lang.String qualifier) The default constructor.

Method Summary

Modifier and Type	Method and Description
org.eclipse.core.runtime.preferences.IEclipsePreferences	getNode(java.lang.String path) Gets the child preferences node from the specified relative path.
java.lang.String	getSecureString(java.lang.String name) Returns the current value of the string-valued, securely stored preference with the given name.
boolean	hasNode(java.lang.String path) Determines whether or not the preference node with the specified relative path exists underneath this store's associated preference node.
boolean	needsSaving()
boolean	removeNode(java.lang.String path) Removes the child preferences node at the specified relative path.
void	removeSecureString(java.lang.String name) Removes the specified, securely stored value from the store.
void	removeValue(java.lang.String name) Removes the specified value (including its defaults) from the store.
void	save()
void	setSecureValue(java.lang.String name, java.lang.String value) Sets the current value of the string-valued, securely stored preference with the given name.

Methods inherited from class org.eclipse.ui.preferences.ScopedPreferenceStore

addPropertyChangeListener, contains, firePropertyChangeEvent, getBoolean, getDefaultBoolean, getDefaultDouble, getDefaultFloat, getDefaultInt, getDefaultLong, getDefaultString, getDouble, getFloat, getInt, getLong, getPreferenceNodes, getString, isDefault, putValue, removePropertyChangeListener, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setSearchContexts, setToDefault, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomScopedPreferenceStore

public CustomScopedPreferenceStore(java.lang.Class<?> clazz)

A convenient constructor for getting a default CustomScopedPreferenceStore for a class' bundle.

Parameters:

clazz - The target class.

CustomScopedPreferenceStore

public CustomScopedPreferenceStore(org.eclipse.core.runtime.preferences.IScopeContext context,
                                   java.lang.String qualifier)

The default constructor.

Parameters:

context - The scope to store to, e.g., InstanceScope.INSTANCE.

qualifier - The qualifer used to look up the preference node, e.g., the bundle's ID.

Method Detail

getNode

public org.eclipse.core.runtime.preferences.IEclipsePreferences getNode(java.lang.String path)

Gets the child preferences node from the specified relative path. If such a node did not exist previously, it will be created.

Parameters:

path - The relative path. A relative path must not start with "/" (meaning it is an absolute path) and must not be an empty string (meaning it is the primary node itself).

Returns:

The child preference node, or null if the path was invalid.

getSecureString

public java.lang.String getSecureString(java.lang.String name)

Returns the current value of the string-valued, securely stored preference with the given name.

Returns the default-default value (the empty string "") if there is no preference with the given name, or if the current value cannot be treated as a string.

Parameters:

name - The name of the preference.

Returns:

The string-valued preference, which is stored securely.

hasNode

public boolean hasNode(java.lang.String path)

Determines whether or not the preference node with the specified relative path exists underneath this store's associated preference node.

Parameters:

path - The relative path. A relative path must not start with "/" (meaning it is an absolute path) and must not be an empty string (meaning it is the primary node itself).

Returns:

True if the store's primary node contains a child node with the specified relative path, false otherwise.

needsSaving

public boolean needsSaving()

Specified by:

needsSaving in interface org.eclipse.jface.preference.IPreferenceStore

Overrides:

needsSaving in class org.eclipse.ui.preferences.ScopedPreferenceStore

removeNode

public boolean removeNode(java.lang.String path)

Removes the child preferences node at the specified relative path.

This operation should be used instead of calling IEclipsePreferences.removeNode(), as the parent node needs to be flushed afterward.

Parameters:

path - The relative path. A relative path must not start with "/" (meaning it is an absolute path) and must not be an empty string (meaning it is the primary node itself).

Returns:

True if an IEclipsePreferences node was removed from the store, false otherwise.

removeSecureString

public void removeSecureString(java.lang.String name)

Removes the specified, securely stored value from the store.

Parameters:

name - The name of the value to remove.

removeValue

public void removeValue(java.lang.String name)

Removes the specified value (including its defaults) from the store.

Parameters:

name - The name of the value to remove.

save

public void save()
          throws java.io.IOException

Specified by:

save in interface org.eclipse.jface.preference.IPersistentPreferenceStore

Overrides:

save in class org.eclipse.ui.preferences.ScopedPreferenceStore

Throws:

java.io.IOException

setSecureValue

public void setSecureValue(java.lang.String name,
                           java.lang.String value)

Sets the current value of the string-valued, securely stored preference with the given name.

A property change event is reported if the current value of the preference actually changes from its previous value. In the event object, the property name is the name of the preference, and the old and new values are wrapped as objects.

Parameters:

name - The name of the preference.

value - The value of the preference that must be stored securely.