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

Class SettingState<T extends java.lang.Comparable<T>>

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.setting.SettingState<T>

Direct Known Subclasses:

SettingStateBoolean, SettingStateBooleanOption, SettingStateLocale

public abstract class SettingState<T extends java.lang.Comparable<T>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SettingState(java.lang.String id, boolean isPrivate, java.lang.Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	convertToString(T value) Convert the provided object to string.
boolean	equals(java.lang.Object obj)
abstract T	getDefault() Get the default object that would be provided normally
abstract java.util.Optional<T>	getFrom(java.lang.String value) Get an optional from the provided string.
java.lang.String	getId()
java.lang.Class<T>	getType()
abstract java.util.Collection<java.lang.String>	getValues() Get all the valid values that this state could take on.
boolean	isPrivate()

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingState

public SettingState(java.lang.String id,
                    boolean isPrivate,
                    java.lang.Class<T> clazz)

Method Detail

getId

public final java.lang.String getId()

isPrivate

public final boolean isPrivate()

getType

public final java.lang.Class<T> getType()

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

convertToString

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

Convert the provided object to string.

Parameters:

value - The value that needs converting.

Returns:

A string which may be used in serialization.

getFrom

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

Get an optional from the provided string.

Parameters:

value - A string representing a value of the object.

Returns:

An optional that may contain a valid object.

getValues

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

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

Returns:

A collection of all valid states.

getDefault

public abstract T getDefault()

Get the default object that would be provided normally

Returns:

The default object