org.eclipse.ocl.options

Class BasicOption<T>

java.lang.Object

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

All Implemented Interfaces:

Option<T>

Direct Known Subclasses:

BooleanOption, ClassOption, EnumeratedOption, ObjectOption

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

Useful implementation of the Option interface for OCL parsing options.

Author:

Christian W. Damus (cdamus)

Constructor Summary

Constructors

Constructor and Description
BasicOption(java.lang.String pluginId, java.lang.String key, T defaultValue) Initializes me with my plugin-qualified key and default value.
BasicOption(java.lang.String key, T defaultValue) Initializes me with my key and default value for an unspecified plugin.

Method Summary

Methods

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()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOption

public BasicOption(java.lang.String key,
           T defaultValue)

Initializes me with my key and default value for an unspecified plugin.

Parameters:

key - identifies me

defaultValue - my default value

BasicOption

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

Initializes me with my plugin-qualified key and default value.

Parameters:

pluginId - identifies my plugin

key - identifies me

defaultValue - my default value

Since:

3.2

Method Detail

getKey

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 Option<T>

Returns:

my key. Is never null

getPluginId

public java.lang.String getPluginId()

Since:

3.2

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDefaultValue

public final T getDefaultValue()

Description copied from interface: Option

Obtains the option's default value.

Specified by:

getDefaultValue in interface Option<T>

Returns:

my default value, which default-default is null