org.eclipse.sphinx.platform.preferences

Interface IProjectWorkspacePreference<T>

All Superinterfaces:

IEclipsePreference<T>

All Known Implementing Classes:

AbstractProjectWorkspacePreference, OutletsPreference, PrDefaultExcludesPreference, PrExcludesPreference

public interface IProjectWorkspacePreference<T>
extends IEclipsePreference<T>

Interface enabling the retrieving and setting of one Eclipse preference that may be store both as a project preference or as a workspace preference.

Extends the IEclipsePreference by adding the support for a required project nature identifier. This may be used to make the property dependent of a specific project nature.

Defines several gets and sets methods to retrieve and set the value 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()
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	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()

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

getDefaultValueAsString, getKey, getQualifier

Method Detail

getRequiredProjectNatureId

java.lang.String getRequiredProjectNatureId()

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

Returns:

the required project nature

get

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

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.

Parameters:

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

Returns:

the value of the preference

getDefaultValueAsObject

T getDefaultValueAsObject()

getFromProject

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

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.

Parameters:

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

Returns:

the value of the preference

See Also:

IProjectPreference.get(IProject)

setInProject

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

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.

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

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

addPreferenceChangeListenerToProject

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. Calling this method multiple times with the same listener has no effect. The given listener argument must not be null.

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

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. Calling this method multiple times with the same listener has no effect. The given listener argument must not be null.

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

T getFromWorkspace()

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.

Returns:

the value of the preference

See Also:

IWorkspacePreference.get()

getFromWorkspaceForProject

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

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.

Parameters:

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

Returns:

the value of the preference

See Also:

IWorkspacePreference.get()

setInWorkspace

void setInWorkspace(T valueAsObject)

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

Parameters:

valueAsObject - the new value of the preference

See Also:

IWorkspacePreference.set(Object)

setToDefaultInWorkspace

void setToDefaultInWorkspace()

addPreferenceChangeListenerToWorkspace

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

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.

Parameters:

listener - the preference change listener to register

See Also:

#removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener

removePreferenceChangeListenerFromWorkspace

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

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.

Parameters:

listener - the preference change listener to remove

See Also:

#addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener), IEclipsePreferences.IPreferenceChangeListener