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

Class SettingStateLocale

java.lang.Object

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

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

public class SettingStateLocale
extends SettingState<java.lang.String>

Constructor Summary

Constructors

Constructor and Description
SettingStateLocale(java.lang.String id, boolean isPrivate)

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertToString(java.lang.String value) Convert the provided object to string.
java.lang.String	getDefault() Get the default object that would be provided normally
java.util.Optional<java.lang.String>	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.

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

SettingStateLocale

public SettingStateLocale(java.lang.String id,
                          boolean isPrivate)

Method Detail

convertToString

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

Description copied from class: SettingState

Convert the provided object to string.

Specified by:

convertToString in class SettingState<java.lang.String>

Parameters:

value - The value that needs converting.

Returns:

A string which may be used in serialization.

getFrom

public java.util.Optional<java.lang.String> 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.String>

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.String>

Returns:

A collection of all valid states.

getDefault

public java.lang.String getDefault()

Description copied from class: SettingState

Get the default object that would be provided normally

Specified by:

getDefault in class SettingState<java.lang.String>

Returns:

The default object