org.eclipse.ocl.pivot.options

Class BasicOption<T>

java.lang.Object

org.eclipse.ocl.pivot.options.BasicOption<T>

All Implemented Interfaces:

PreferenceableOption<T>, Option<T>

Direct Known Subclasses:

EnumeratedOption

public abstract class BasicOption<T>
extends java.lang.Object
implements Option<T>, PreferenceableOption<T>

Abstract implementation of a configurable option that can also be a preference.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.common.preferences.PreferenceableOption

PreferenceableOption.Listener, PreferenceableOption.PreferenceableOption2<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected T	defaultValue
protected java.lang.String	key
protected java.lang.String	pluginId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicOption(java.lang.String pluginId, java.lang.String key, T defaultValue)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

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

getValueOf

Field Detail

pluginId

@NonNull
protected final java.lang.String pluginId

key

@NonNull
protected final java.lang.String key

defaultValue

protected final T defaultValue

Constructor Detail

BasicOption

protected BasicOption(@NonNull
                      java.lang.String pluginId,
                      @NonNull
                      java.lang.String key,
                      T defaultValue)

Method Detail

getKey

@NonNull
public final java.lang.String getKey()

Description copied from interface: Option

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

Specified by:

getKey in interface PreferenceableOption<T>

Specified by:

getKey in interface Option<T>

Returns:

my key. Is never null

getDefaultValue

public final T getDefaultValue()

Description copied from interface: Option

Obtains the option's default value.

Specified by:

getDefaultValue in interface PreferenceableOption<T>

Specified by:

getDefaultValue in interface Option<T>

Returns:

my default value, which default-default is null

getPluginId

@NonNull
public final java.lang.String getPluginId()

Description copied from interface: PreferenceableOption

Returns the plugin qualifier for the key.

Specified by:

getPluginId in interface PreferenceableOption<T>