org.eclipse.sphinx.platform.preferences

Interface IEclipsePreference<T>

All Known Subinterfaces:

IProjectPreference<T>, IProjectWorkspacePreference<T>, IWorkspacePreference<T>

All Known Implementing Classes:

AbstractEclipsePreference, AbstractProjectPreference, AbstractProjectWorkspacePreference, AbstractWorkspacePreference, BooleanWorkspacePreference, IntegerWorkspacePreference, OutletsPreference, PrDefaultExcludesPreference, PrExcludesPreference, StringWorkspacePreference

public interface IEclipsePreference<T>

Interface enabling the retrieving and setting of one Eclipse preference. This preference may be a workspace preference, a project preference, or both. T is the type of the preference.

Supports automatic conversion of string-based preference values returned by IEclipsePreferences API to corresponding domain objects and vice versa.

Compared with the default property mechanism, this interface adds the support for a default value that is used when the given property is not set.

A class implementing this interface gets and set the preference value by using the Eclipse preferences mechanism.

See Also:

Preferences, IEclipsePreferences, ProjectScope, InstanceScope

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultValueAsString() Returns the default value for the preference.
java.lang.String	getKey() Returns the key of the preference.
java.lang.String	getQualifier() Returns the qualifier of the preference.

Method Detail

getQualifier

java.lang.String getQualifier()

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

Returns:

the qualifier of the preference

getKey

java.lang.String getKey()

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

Returns:

the key of the preference

getDefaultValueAsString

java.lang.String getDefaultValueAsString()

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.

Returns:

the default value for the preference