org.eclipse.sphinx.platform.preferences

Class AbstractProjectPreference<T>

java.lang.Object

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

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

All Implemented Interfaces:

IEclipsePreference<T>, IProjectPreference<T>

public abstract class AbstractProjectPreference<T>
extends AbstractEclipsePreference<T>
implements IProjectPreference<T>

Abstract implementation of IProjectPreference. 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

Modifier and Type	Field and Description
protected java.lang.String	requiredProjectNatureId Project nature that is required by the preference.

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

defaultValueAsString, key, qualifier

Constructor Summary

Constructors

Constructor and Description
AbstractProjectPreference(java.lang.String requiredProjectNatureId, 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.resources.IProject project, org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Registers the given listener for notification of changes of this preference in specified project.
T	get(org.eclipse.core.resources.IProject project) Returns the value of the preference.
T	getDefaultValueAsObject(org.eclipse.core.resources.IProject project)
protected org.eclipse.core.runtime.preferences.IEclipsePreferences	getProjectPreferences(org.eclipse.core.resources.IProject project) Get the Eclipse preferences associated with the project.
java.lang.String	getRequiredProjectNatureId() Return the identifier of the project nature that is required by the preference.
void	removePreferenceChangeListener(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Unregisters the given listener from receiving notification of changes of this preference in specified project.
void	set(org.eclipse.core.resources.IProject project, T valueAsObject) Set the value of the preference.
void	setToDefault(org.eclipse.core.resources.IProject project)
protected T	toObject(org.eclipse.core.resources.IProject project, 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(org.eclipse.core.resources.IProject project, 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

Field Detail

requiredProjectNatureId

protected java.lang.String requiredProjectNatureId

Project nature that is required by the preference.

Constructor Detail

AbstractProjectPreference

public AbstractProjectPreference(java.lang.String requiredProjectNatureId,
                         java.lang.String qualifier,
                         java.lang.String key,
                         java.lang.String defaultValueAsString)

Constructor of the preference.

Parameters:

requiredProjectNatureId - the project nature that is required by the preference

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

getRequiredProjectNatureId

public java.lang.String getRequiredProjectNatureId()

Description copied from interface: IProjectPreference

Return the identifier of the project nature that is required by the preference.

Specified by:

getRequiredProjectNatureId in interface IProjectPreference<T>

Returns:

the required project nature

get

public T get(org.eclipse.core.resources.IProject project)

Description copied from interface: IProjectPreference

Returns the value of the preference. If the value does not exist yet in the Eclipse preferences mechanism, returns the default value. The returned value may depend on the nature of the project that is provided as a parameter.

Specified by:

get in interface IProjectPreference<T>

Parameters:

project - the project for which the preference is retrieved

Returns:

the value of the preference

See Also:

IEclipsePreference.getDefaultValueAsString()

set

public void set(org.eclipse.core.resources.IProject project,
       T valueAsObject)

Description copied from interface: IProjectPreference

Set the value of the preference. The behavior of this method may depend on the nature of the project that is provided as a parameter. The value is provided as an object.

Specified by:

set in interface IProjectPreference<T>

Parameters:

project - the project for which the preference is retrieved

valueAsObject - the new value of the preference

getDefaultValueAsObject

public T getDefaultValueAsObject(org.eclipse.core.resources.IProject project)

Specified by:

getDefaultValueAsObject in interface IProjectPreference<T>

setToDefault

public void setToDefault(org.eclipse.core.resources.IProject project)

Specified by:

setToDefault in interface IProjectPreference<T>

addPreferenceChangeListener

public void addPreferenceChangeListener(org.eclipse.core.resources.IProject project,
                               org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IProjectPreference

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

Parameters:

project - the project in which the changes of this preference are to be observed

listener - the preference change listener to register

See Also:

#removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

removePreferenceChangeListener

public void removePreferenceChangeListener(org.eclipse.core.resources.IProject project,
                                  org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener)

Description copied from interface: IProjectPreference

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

Parameters:

project - the project in which the changes of this preference have been observed

listener - the preference change listener to remove

See Also:

#addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

getProjectPreferences

protected org.eclipse.core.runtime.preferences.IEclipsePreferences getProjectPreferences(org.eclipse.core.resources.IProject project)

Get the Eclipse preferences associated with the project. project should not be null.

Parameters:

project - the project from which the preferences are retrieved

Returns:

the node containing the preferences

See Also:

ProjectScope.getNode(String)

toObject

protected T toObject(org.eclipse.core.resources.IProject project,
         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(org.eclipse.core.resources.IProject project,
                        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