org.eclipse.sphinx.platform.preferences

Class AbstractProjectWorkspacePreference<T>

java.lang.Object

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

All Implemented Interfaces:

IEclipsePreference<T>, IProjectWorkspacePreference<T>

Direct Known Subclasses:

OutletsPreference, PrDefaultExcludesPreference, PrExcludesPreference

public abstract class AbstractProjectWorkspacePreference<T>
extends java.lang.Object
implements IProjectWorkspacePreference<T>

Abstract implementation of IProjectWorkspacePreference. 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 AbstractProjectPreference<T>	projectPreference Project preference corresponding to the current preference.
protected AbstractWorkspacePreference<T>	workspacePreference Workspace preference corresponding to the current preference.

Constructor Summary

Constructors

Constructor and Description
AbstractProjectWorkspacePreference(java.lang.String requiredProjectNatureId, java.lang.String qualifier, java.lang.String key, java.lang.String defaultValueAsString) Constructor of the preference using the same qualifier is used at project level and at workspace level.
AbstractProjectWorkspacePreference(java.lang.String requiredProjectNatureId, java.lang.String projectLevelQualifier, java.lang.String workspaceLevelQualifier, java.lang.String key, java.lang.String defaultValueAsString) Constructor of the preference.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPreferenceChangeListenerToProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Registers the given listener for notification of project-level changes of this preference in specified project.
void	addPreferenceChangeListenerToWorkspace(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Registers the given listener for notification of workspace-level changes of this preference.
T	get(org.eclipse.core.resources.IProject project) Returns the value of the preference.
T	getDefaultValueAsObject()
java.lang.String	getDefaultValueAsString() Returns the default value for the preference.
T	getFromProject(org.eclipse.core.resources.IProject project) Returns the value of the preference from the project.
T	getFromWorkspace() Returns the value of the preference from the workspace.
T	getFromWorkspaceForProject(org.eclipse.core.resources.IProject project) Returns the value of the preference from the workspace.
java.lang.String	getKey() Returns the key of the preference.
java.lang.String	getQualifier() Returns the qualifier of the preference.
java.lang.String	getRequiredProjectNatureId() Return the identifier of the project nature that is required by the preference.
void	removePreferenceChangeListenerFromProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Unregisters the given listener from receiving notification of project-level changes of this preference in specified project.
void	removePreferenceChangeListenerFromWorkspace(org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener listener) Unregisters the given listener from receiving notification of workspace-level changes of this preference.
void	setInProject(org.eclipse.core.resources.IProject project, T valueAsObject) Set the value of the preference in the project.
void	setInWorkspace(T valueAsObject) Sets the value of the preference in the workspace.
void	setToDefaultInProject(org.eclipse.core.resources.IProject project)
void	setToDefaultInWorkspace()
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 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(org.eclipse.core.resources.IProject project, T valueAsObject) Converts the valueAsObject, that is a possible object value for the preference, into a string 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 java.lang.Object

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

Field Detail

projectPreference

protected AbstractProjectPreference<T> projectPreference

Project preference corresponding to the current preference.

workspacePreference

protected AbstractWorkspacePreference<T> workspacePreference

Workspace preference corresponding to the current preference.

Constructor Detail

AbstractProjectWorkspacePreference

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

Constructor of the preference using the same qualifier is used at project level and at workspace level.

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:

AbstractProjectWorkspacePreference(String, String, String, String, String)

AbstractProjectWorkspacePreference

public AbstractProjectWorkspacePreference(java.lang.String requiredProjectNatureId,
                                  java.lang.String projectLevelQualifier,
                                  java.lang.String workspaceLevelQualifier,
                                  java.lang.String key,
                                  java.lang.String defaultValueAsString)

Constructor of the preference.

Parameters:

requiredProjectNatureId - the project nature that is required by the preference

projectLevelQualifier - the qualifier of the preference at project level

workspaceLevelQualifier - the qualifier of the preference at workspace level

key - the key of the preference

defaultValueAsString - the default value of the preference

Method Detail

getQualifier

public java.lang.String getQualifier()

Returns the qualifier of the preference.

In the case where the project level qualifier and the workspace level qualifiers are different, this implementation returns the latter. This method may be overwritten by subclasses if necessary.

Specified by:

getQualifier in interface IEclipsePreference<T>

Returns:

the qualifier of the preference

See Also:

IEclipsePreference.getQualifier()

getKey

public java.lang.String getKey()

Description copied from interface: IEclipsePreference

Returns the key of the preference. This key is used to identify the preference in the Eclipse preferences mechanism.

Specified by:

getKey in interface IEclipsePreference<T>

Returns:

the key of the preference

getDefaultValueAsString

public java.lang.String getDefaultValueAsString()

Description copied from interface: IEclipsePreference

Returns the default value for the preference. This value may be used when no actual value is registered for this preference. The value is returned as a String, whatever the type of the preference is.

Specified by:

getDefaultValueAsString in interface IEclipsePreference<T>

Returns:

the default value for the preference

getRequiredProjectNatureId

public java.lang.String getRequiredProjectNatureId()

Description copied from interface: IProjectWorkspacePreference

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

Specified by:

getRequiredProjectNatureId in interface IProjectWorkspacePreference<T>

Returns:

the required project nature

get

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

Description copied from interface: IProjectWorkspacePreference

Returns the value of the preference. The preference is first searched in the project, then in the workspace, then the default value is used. The behavior of this method may depend on the nature of the project that is provided as a parameter.

Specified by:

get in interface IProjectWorkspacePreference<T>

Parameters:

project - the project for which the preference is to be retrieved

Returns:

the value of the preference

getDefaultValueAsObject

public T getDefaultValueAsObject()

Specified by:

getDefaultValueAsObject in interface IProjectWorkspacePreference<T>

getFromProject

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

Description copied from interface: IProjectWorkspacePreference

Returns the value of the preference from the project. If the value does not exist yet in the Eclipse project preferences mechanism null is returned. The behavior of this method may depend on the nature of the project that is provided as a parameter.

Specified by:

getFromProject in interface IProjectWorkspacePreference<T>

Parameters:

project - the project for which the preference is to be retrieved

Returns:

the value of the preference

See Also:

IProjectPreference.get(IProject)

setInProject

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

Description copied from interface: IProjectWorkspacePreference

Set the value of the preference in the project. 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:

setInProject in interface IProjectWorkspacePreference<T>

Parameters:

project - the project for which the preference is to be retrieved

valueAsObject - the new value of the preference

See Also:

IProjectPreference.set(IProject, Object)

setToDefaultInProject

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

Specified by:

setToDefaultInProject in interface IProjectWorkspacePreference<T>

addPreferenceChangeListenerToProject

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

Description copied from interface: IProjectWorkspacePreference

Registers the given listener for notification of project-level 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:

addPreferenceChangeListenerToProject in interface IProjectWorkspacePreference<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

removePreferenceChangeListenerFromProject

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

Description copied from interface: IProjectWorkspacePreference

Unregisters the given listener from receiving notification of project-level 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:

removePreferenceChangeListenerFromProject in interface IProjectWorkspacePreference<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

getFromWorkspace

public T getFromWorkspace()

Description copied from interface: IProjectWorkspacePreference

Returns the value of the preference from the workspace. If the value does not exist yet in the Eclipse workspace preferences mechanism the default value is returned.

Specified by:

getFromWorkspace in interface IProjectWorkspacePreference<T>

Returns:

the value of the preference

See Also:

IWorkspacePreference.get()

getFromWorkspaceForProject

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

Description copied from interface: IProjectWorkspacePreference

Returns the value of the preference from the workspace. Enables the given project to be taken into account during conversion of the preference's string value to the corresponding object value. If the value does not exist yet in the Eclipse workspace preferences mechanism the default value is returned. The behavior of this method may depend on the nature of the project that is provided as a parameter.

Specified by:

getFromWorkspaceForProject in interface IProjectWorkspacePreference<T>

Parameters:

project - the project for which the preference is to be retrieved

Returns:

the value of the preference

See Also:

IWorkspacePreference.get()

setInWorkspace

public void setInWorkspace(T valueAsObject)

Description copied from interface: IProjectWorkspacePreference

Sets the value of the preference in the workspace. The value is provided as an object.

Specified by:

setInWorkspace in interface IProjectWorkspacePreference<T>

Parameters:

valueAsObject - the new value of the preference

See Also:

IWorkspacePreference.set(Object)

setToDefaultInWorkspace

public void setToDefaultInWorkspace()

Specified by:

setToDefaultInWorkspace in interface IProjectWorkspacePreference<T>

addPreferenceChangeListenerToWorkspace

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

Description copied from interface: IProjectWorkspacePreference

Registers the given listener for notification of workspace-level 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:

addPreferenceChangeListenerToWorkspace in interface IProjectWorkspacePreference<T>

Parameters:

listener - the preference change listener to register

See Also:

#removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

removePreferenceChangeListenerFromWorkspace

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

Description copied from interface: IProjectWorkspacePreference

Unregisters the given listener from receiving notification of workspace-level 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:

removePreferenceChangeListenerFromWorkspace in interface IProjectWorkspacePreference<T>

Parameters:

listener - the preference change listener to remove

See Also:

#addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

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 the result of toObject(String). This method may 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 this method returns the result of toString(Object). 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

toObject

protected T toObject(java.lang.String valueAsString)

Converts the valueAsString, that is a possible string value for the preference, into an object value. This conversion do not depend on the nature of the project.

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

Parameters:

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. This conversion do not depend on the nature of the project.

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