org.eclipse.sphinx.platform.preferences

Interface IWorkspacePreference<T>

All Superinterfaces:

IEclipsePreference<T>

All Known Implementing Classes:

AbstractWorkspacePreference, BooleanWorkspacePreference, IntegerWorkspacePreference, StringWorkspacePreference

public interface IWorkspacePreference<T>
extends IEclipsePreference<T>

Interface enabling the retrieving and setting of one Eclipse workspace preference.

Extends the IEclipsePreference to define get and set methods to retrieve and set the value 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()
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()

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

getDefaultValueAsString, getKey, getQualifier

Method Detail

get

T get()

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

Returns:

the value of the preference

See Also:

IEclipsePreference.getDefaultValueAsString()

set

void set(T valueAsObject)

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

Parameters:

valueAsObject - the new value of the preference

getDefaultValueAsObject

T getDefaultValueAsObject()

setToDefault

void setToDefault()

addPreferenceChangeListener

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

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.

Parameters:

listener - the preference change listener to register

See Also:

removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

removePreferenceChangeListener

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

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.

Parameters:

listener - the preference change listener to remove

See Also:

addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener