org.eclipse.sphinx.platform.preferences

Class AbstractEclipsePreference<T>

java.lang.Object

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

All Implemented Interfaces:

IEclipsePreference<T>

Direct Known Subclasses:

AbstractProjectPreference, AbstractWorkspacePreference

public abstract class AbstractEclipsePreference<T>
extends java.lang.Object
implements IEclipsePreference<T>

Abstract implementation of IEclipsePreference.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultValueAsString Default string value for the preference.
protected java.lang.String	key Key of the preference.
protected java.lang.String	qualifier Qualifier of the preference.

Constructor Summary

Constructors

Constructor and Description
AbstractEclipsePreference(java.lang.String qualifier, java.lang.String key, java.lang.String defaultValueAsString) Constructor of the class.

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

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

Field Detail

qualifier

protected final java.lang.String qualifier

Qualifier of the preference.

key

protected final java.lang.String key

Key of the preference.

defaultValueAsString

protected final java.lang.String defaultValueAsString

Default string value for the preference.

Constructor Detail

AbstractEclipsePreference

public AbstractEclipsePreference(java.lang.String qualifier,
                         java.lang.String key,
                         java.lang.String defaultValueAsString)

Constructor of the class. Records the qualifier and the key that identify the preference, and the default value. The qualifier and the key should not be null. The default value is provided as a string.

Parameters:

qualifier - the qualifier of the preference

key - the key of the preference

defaultValueAsString - the default value of the preference

Method Detail

getQualifier

public java.lang.String getQualifier()

Description copied from interface: IEclipsePreference

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

Specified by:

getQualifier in interface IEclipsePreference<T>

Returns:

the qualifier of the preference

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