net.viktorc.detroid.framework.uci

Class Option<T>

Object

Option<T>

Type Parameters:

T - The type that determines the type of the default value and the allowed values of the option.

Direct Known Subclasses:

Option.ButtonOption, Option.CheckOption, Option.ComboOption, Option.SpinOption, Option.StringOption

public class Option<T>
extends Object

A parameterized type for storing a name, and possibly a default value, minimum and maximum values and a set of allowed values for different setting types.

Author:

Viktor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Option.ButtonOption A button option which only has a name and serves as a parameterless command.
static class	Option.CheckOption A check option subclassing Setting with a Boolean type parameter.
static class	Option.ComboOption A combo option with a set of allowed values subclassing Setting with a String type parameter.
static class	Option.SpinOption A spin option with minimum and maximum values subclassing Setting with an Integer type parameter.
static class	Option.StringOption A simple string option subclassing Setting with a String type parameter.

Method Summary

Modifier and Type	Method and Description
Optional<Set<T>>	getAllowedValues() Returns an optional set of values a Option.ComboOption can possibly take on.
Optional<T>	getDefaultValue() Returns the optional default value of the setting.
Optional<Integer>	getMax() Returns the optional maximum value for the setting.
Optional<Integer>	getMin() Returns the optional minimum value for the setting.
String	getName() Returns the name ID of the setting.

Methods inherited from class Object

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

Method Detail

getName

public String getName()

Returns the name ID of the setting.

Returns:

The name ID of the setting.

getDefaultValue

public Optional<T> getDefaultValue()

Returns the optional default value of the setting. For a Option.ButtonOption, it is never present; for all other option types, it is always present.

Returns:

The default value of the option.

getAllowedValues

public Optional<Set<T>> getAllowedValues()

Returns an optional set of values a Option.ComboOption can possibly take on. For all other option types, it is never present.

Returns:

The set of allowed values for this option.

getMin

public Optional<Integer> getMin()

Returns the optional minimum value for the setting. For option types other than Option.SpinOption, it is never present.

Returns:

The minimum allowed value for this option.

getMax

public Optional<Integer> getMax()

Returns the optional maximum value for the setting. For option types other than Option.SpinOption, it is never present.

Returns:

The maximum allowed value for this option.