Class ModeOption<T extends Enum<T>>

java.lang.Object

dev.boze.api.option.Option<T>

dev.boze.api.option.ModeOption<T>

Type Parameters:

T - The enum type defining the available modes

All Implemented Interfaces:

Serializable<T>

public class ModeOption<T extends Enum<T>>
extends Option<T>

An option for selecting from a predefined set of modes
ModeOption provides a way to store and modify enum values
The available modes are defined by the enum type parameter

Field Summary

Fields inherited from class Option

description, name, owner

Constructor Summary

Constructors

Constructor	Description
ModeOption(BaseModule owner, String name, String description, T defaultValue)	Creates a new mode option
ModeOption(BaseModule owner, String name, String description, T defaultValue, Option<?> parent)	Creates a new mode option with a parent
ModeOption(BaseModule owner, String name, String description, T defaultValue, BooleanSupplier visibility)	Creates a new mode option with visibility
ModeOption(BaseModule owner, String name, String description, T defaultValue, BooleanSupplier visibility, Option<?> parent)	Creates a new mode option with visibility and parent

Method Summary

Modifier and Type	Method	Description
T	fromJson(com.google.gson.JsonObject object)
Class<T>	getEnumClass()	Gets the enum class of this mode option
String	getModeName()	Gets the name of the current mode
List<String>	getModes()	Gets a list of all available mode names
T	getValue()	Gets the current value of this option
String	getValueName()	Gets the name of the current value
T	reset()	Resets this option to its default value
T	setValue(T newValue)	Sets the value of this option
void	setValueByName(String name)	Sets the current mode by name
com.google.gson.JsonObject	toJson()

Methods inherited from class Option

getFullName, getParent, isParent, isVisible, setParent, setVisibility

Methods inherited from class Object

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

Constructor Details

ModeOption

public ModeOption(BaseModule owner,
 String name,
 String description,
 T defaultValue)

Creates a new mode option

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

defaultValue - The initial value and default value

ModeOption

public ModeOption(BaseModule owner,
 String name,
 String description,
 T defaultValue,
 Option<?> parent)

Creates a new mode option with a parent

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

defaultValue - The initial value and default value

parent - The parent option, or null if this is a root option

ModeOption

public ModeOption(BaseModule owner,
 String name,
 String description,
 T defaultValue,
 BooleanSupplier visibility)

Creates a new mode option with visibility

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

defaultValue - The initial value and default value

visibility - The visibility supplier for this option

ModeOption

public ModeOption(BaseModule owner,
 String name,
 String description,
 T defaultValue,
 BooleanSupplier visibility,
 Option<?> parent)

Creates a new mode option with visibility and parent

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

defaultValue - The initial value and default value

visibility - The visibility supplier for this option

parent - The parent option, or null if this is a root option

Method Details

getEnumClass

public Class<T> getEnumClass()

Gets the enum class of this mode option

Returns:

The enum class

getModes

public List<String> getModes()

Gets a list of all available mode names

Returns:

List of mode names

getModeName

public String getModeName()

Gets the name of the current mode

Returns:

The current mode name

getValueName

public String getValueName()

Gets the name of the current value

Returns:

The current value name

getValue

public T getValue()

Description copied from class: Option

Gets the current value of this option

Specified by:

getValue in class Option<T extends Enum<T>>

Returns:

The current value

setValue

public T setValue(T newValue)

Description copied from class: Option

Sets the value of this option

Specified by:

setValue in class Option<T extends Enum<T>>

Parameters:

newValue - The new value to set

Returns:

The value that was set (may be different from newValue if validation was performed)

reset

public T reset()

Description copied from class: Option

Resets this option to its default value

Specified by:

reset in class Option<T extends Enum<T>>

Returns:

The default value

setValueByName

public void setValueByName(String name)

Sets the current mode by name

The name is case-insensitive

Parameters:

name - The name of the mode to set

toJson

public com.google.gson.JsonObject toJson()

Returns:

The object as a JsonObject

fromJson

public T fromJson(com.google.gson.JsonObject object)

Parameters:

object - The JsonObject to deserialize

Returns:

The deserialized object