org.eclipse.sphinx.platform.preferences

Class AbstractWorkspacePreference<T>

java.lang.Object

org.eclipse.sphinx.platform.preferences.AbstractEclipsePreference<T>

org.eclipse.sphinx.platform.preferences.AbstractWorkspacePreference<T>

All Implemented Interfaces:

IEclipsePreference<T>, IWorkspacePreference<T>

Direct Known Subclasses:

BooleanWorkspacePreference, IntegerWorkspacePreference, StringWorkspacePreference

public abstract class AbstractWorkspacePreference<T>
extends AbstractEclipsePreference<T>
implements IWorkspacePreference<T>

Abstract implementation of IWorkspacePreference. Provides almost all logic required for being used with a concrete preference.

Defines two methods, toObject(String) and toString(Object), to convert the preference values. These methods should be overwritten by the subclasses.

Field Summary

Fields inherited from class org.eclipse.sphinx.platform.preferences.AbstractEclipsePreference

defaultValueAsString, key, qualifier

Constructor Summary

Constructors

Constructor and Description
AbstractWorkspacePreference(java.lang.String qualifier, java.lang.String key, java.lang.String defaultValueAsString) Constructor of the preference.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPreferenceChangeListener(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Registers the given listener for notification of changes of this preference.
T	get() Returns the value of the preference.
T	getDefaultValueAsObject()
protected org.eclipse.core.runtime.preferences.IEclipsePreferences	getWorkspacePreferences() Get the Eclipse preferences associated with the workspace.
void	removePreferenceChangeListener(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Unregisters the given listener from receiving notification of changes of this preference.
void	set(T valueAsObject) Set the value of the preference.
void	setToDefault()
protected T	toObject(java.lang.String valueAsString) Converts the valueAsString, that is a possible string value for the preference, into an object value.
protected java.lang.String	toString(T valueAsObject) Converts the valueAsObject, that is a possible object value for the preference, into a string value.

Methods inherited from class org.eclipse.sphinx.platform.preferences.AbstractEclipsePreference

getDefaultValueAsString, getKey, getQualifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.sphinx.platform.preferences.IEclipsePreference

getDefaultValueAsString, getKey, getQualifier

Constructor Detail

AbstractWorkspacePreference

public AbstractWorkspacePreference(java.lang.String qualifier,
                           java.lang.String key,
                           java.lang.String defaultValueAsString)

Constructor of the preference.

Parameters:

qualifier - the qualifier of the preference

key - the key of the preference

defaultValueAsString - the default value of the preference

See Also:

AbstractEclipsePreference.AbstractEclipsePreference(String, String, String)

Method Detail

get

public T get()

Description copied from interface: IWorkspacePreference

Returns the value of the preference. If the value does not exist yet in the Eclipse preferences mechanism, returns the default value.

Specified by:

get in interface IWorkspacePreference<T>

Returns:

the value of the preference

See Also:

IEclipsePreference.getDefaultValueAsString()

set

public void set(T valueAsObject)

Description copied from interface: IWorkspacePreference

Set the value of the preference. The value is provided as an object.

Specified by:

set in interface IWorkspacePreference<T>

Parameters:

valueAsObject - the new value of the preference

getDefaultValueAsObject

public T getDefaultValueAsObject()

Specified by:

getDefaultValueAsObject in interface IWorkspacePreference<T>

setToDefault

public void setToDefault()

Specified by:

setToDefault in interface IWorkspacePreference<T>

addPreferenceChangeListener

public void addPreferenceChangeListener(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IWorkspacePreference

Registers the given listener for notification of changes of this preference. 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 IWorkspacePreference<T>

Parameters:

listener - the preference change listener to register

See Also:

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

removePreferenceChangeListener

public void removePreferenceChangeListener(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IWorkspacePreference

Unregisters the given listener from receiving notification of changes of this preference. 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 IWorkspacePreference<T>

Parameters:

listener - the preference change listener to remove

See Also:

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

getWorkspacePreferences

protected org.eclipse.core.runtime.preferences.IEclipsePreferences getWorkspacePreferences()

Get the Eclipse preferences associated with the workspace.

Returns:

the node containing the preferences

See Also:

InstanceScope.getNode(String)

toObject

protected T toObject(java.lang.String valueAsString)

Converts the valueAsString, that is a possible string value for the preference, into an object value. The conversion may depend on the nature of the project that is provided.

By default this method returns null. It has to be overwritten by the subclasses.

Parameters:

project - the project the preference depends on

valueAsString - string value to be converted

Returns:

converted object value

toString

protected java.lang.String toString(T valueAsObject)

Converts the valueAsObject, that is a possible object value for the preference, into a string value. The conversion may depend on the nature of the project that is provided.

By default, calls the Object.toString() method of the object value to perform the conversion. It returns null if valueAsObject is null. This method may be overwritten by the subclasses.

Parameters:

project - the project the preference depends on

valueAsObject - object value to be converted

Returns:

converted string value