Class ToggleOption

java.lang.Object

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

dev.boze.api.option.ToggleOption

All Implemented Interfaces:

Serializable<Boolean>

public class ToggleOption
extends Option<Boolean>

A boolean option that can be toggled on or off
ToggleOption provides a simple way to store and modify boolean values
The value can only be true or false

Field Summary

Fields inherited from class Option

description, name, owner

Constructor Summary

Constructors

Constructor	Description
ToggleOption(BaseModule owner, String name, String description)	Creates a new toggle option with a default value of false
ToggleOption(BaseModule owner, String name, String description, boolean value)	Creates a new toggle option with a specified default value
ToggleOption(BaseModule owner, String name, String description, boolean value, Option<?> parent)	Creates a new toggle option with a specified default value and parent
ToggleOption(BaseModule owner, String name, String description, boolean value, BooleanSupplier visibility)	Creates a new toggle option with visibility
ToggleOption(BaseModule owner, String name, String description, boolean value, BooleanSupplier visibility, Option<?> parent)	Creates a new toggle option with visibility and parent

Method Summary

Modifier and Type	Method	Description
Boolean	fromJson(com.google.gson.JsonObject object)
Boolean	getValue()	Gets the current value of this option
Boolean	reset()	Resets this option to its default value
Boolean	setValue(Boolean newValue)	Sets the value of this option
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

ToggleOption

public ToggleOption(BaseModule owner,
 String name,
 String description)

Creates a new toggle option with a default value of false

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

ToggleOption

public ToggleOption(BaseModule owner,
 String name,
 String description,
 boolean value)

Creates a new toggle option with a specified default value

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

value - The initial value

ToggleOption

public ToggleOption(BaseModule owner,
 String name,
 String description,
 boolean value,
 Option<?> parent)

Creates a new toggle option with a specified default value and parent

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

value - The initial value

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

ToggleOption

public ToggleOption(BaseModule owner,
 String name,
 String description,
 boolean value,
 BooleanSupplier visibility)

Creates a new toggle option with visibility

Parameters:

owner - The module that owns this option

name - The name of this option

description - The description of this option

value - The initial value

visibility - The visibility supplier for this option

ToggleOption

public ToggleOption(BaseModule owner,
 String name,
 String description,
 boolean value,
 BooleanSupplier visibility,
 Option<?> parent)

Creates a new toggle 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

value - The initial value

visibility - The visibility supplier for this option

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

Method Details

getValue

public Boolean getValue()

Description copied from class: Option

Gets the current value of this option

Specified by:

getValue in class Option<Boolean>

Returns:

The current value

setValue

public Boolean setValue(Boolean newValue)

Description copied from class: Option

Sets the value of this option

Specified by:

setValue in class Option<Boolean>

Parameters:

newValue - The new value to set

Returns:

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

reset

public Boolean reset()

Description copied from class: Option

Resets this option to its default value

Specified by:

reset in class Option<Boolean>

Returns:

The default value

toJson

public com.google.gson.JsonObject toJson()

Returns:

The object as a JsonObject

fromJson

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

Parameters:

object - The JsonObject to deserialize

Returns:

The deserialized object