io.github.bananapuncher714.cartographer.core.api.setting

Class SettingStateBoolean

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.setting.SettingState<java.lang.Boolean>

io.github.bananapuncher714.cartographer.core.api.setting.SettingStateBoolean

public class SettingStateBoolean
extends SettingState<java.lang.Boolean>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettingStateBoolean(java.lang.String id, boolean isPrivate, boolean defaultValue)

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertToString(java.lang.Boolean value) Convert the provided object to string.
java.lang.Boolean	getDefault() Get the default object that would be provided normally
java.util.Optional<java.lang.Boolean>	getFrom(java.lang.String value) Get an optional from the provided string.
java.util.Collection<java.lang.String>	getValues() Get all the valid values that this state could take on.
static SettingStateBoolean	of(java.lang.String id, boolean isPrivate, boolean defaultValue)

Methods inherited from class io.github.bananapuncher714.cartographer.core.api.setting.SettingState

equals, getId, getType, isPrivate

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingStateBoolean

protected SettingStateBoolean(java.lang.String id,
                              boolean isPrivate,
                              boolean defaultValue)

Method Detail

convertToString

public java.lang.String convertToString(java.lang.Boolean value)

Description copied from class: SettingState

Convert the provided object to string.

Specified by:

convertToString in class SettingState<java.lang.Boolean>

Parameters:

value - The value that needs converting.

Returns:

A string which may be used in serialization.

getFrom

public java.util.Optional<java.lang.Boolean> getFrom(java.lang.String value)

Description copied from class: SettingState

Get an optional from the provided string.

Specified by:

getFrom in class SettingState<java.lang.Boolean>

Parameters:

value - A string representing a value of the object.

Returns:

An optional that may contain a valid object.

getValues

public java.util.Collection<java.lang.String> getValues()

Description copied from class: SettingState

Get all the valid values that this state could take on.

Specified by:

getValues in class SettingState<java.lang.Boolean>

Returns:

A collection of all valid states.

getDefault

public java.lang.Boolean getDefault()

Description copied from class: SettingState

Get the default object that would be provided normally

Specified by:

getDefault in class SettingState<java.lang.Boolean>

Returns:

The default object

of

public static SettingStateBoolean of(java.lang.String id,
                                     boolean isPrivate,
                                     boolean defaultValue)