org.eclipse.ocl.common.internal.preferences
Class Preference<T>

java.lang.Object
  org.eclipse.ocl.common.internal.preferences.Preference<T>

Type Parameters:

T - the type of the option's value

All Implemented Interfaces:

PreferenceableOption<T>

Direct Known Subclasses:

BooleanPreference, ClassPreference, EnumerationPreference, StringPreference

public abstract class Preference<T>
extends java.lang.Object
implements PreferenceableOption<T>

Abstract implementation of a configurable preference option. Derived classes support specific types.

See Also:

BooleanPreference, ClassPreference, EnumerationPreference, IntegerPreference

Field Summary

T	defaultValue
java.lang.String	key
java.lang.String	pluginId

Constructor Summary

Preference(java.lang.String pluginId, java.lang.String key, T defaultValue)

Method Summary

T	getDefaultValue() Obtains the option's default value.
java.lang.String	getKey() Obtains my string key, which may be used for persistence in a preference store.
java.lang.String	getPluginId() Returns the plugin qualifier for the key.
void	setDefaultValue(T defaultValue)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.common.preferences.PreferenceableOption

getValueOf

Field Detail

pluginId

public final java.lang.String pluginId

key

public final java.lang.String key

defaultValue

public T defaultValue

Constructor Detail

Preference

public Preference(java.lang.String pluginId,
                  java.lang.String key,
                  T defaultValue)

Method Detail

getKey

public java.lang.String getKey()

Obtains my string key, which may be used for persistence in a preference store.

Specified by:

getKey in interface PreferenceableOption<T>

Returns:

my key. Is never null

getPluginId

public java.lang.String getPluginId()

Description copied from interface: PreferenceableOption

Returns the plugin qualifier for the key.

Specified by:

getPluginId in interface PreferenceableOption<T>

getDefaultValue

public T getDefaultValue()

Obtains the option's default value.

Specified by:

getDefaultValue in interface PreferenceableOption<T>

Returns:

my default value, which default-default is null

setDefaultValue

public void setDefaultValue(T defaultValue)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object