Package me.hackware.api.setting.impl

Class EnumSetting<E extends Enum<E>>

java.lang.Object

me.hackware.api.setting.Setting<E>

me.hackware.api.setting.ChoiceSetting<E>

me.hackware.api.setting.impl.EnumSetting<E>

public class EnumSetting<E extends Enum<E>>
extends ChoiceSetting<E>

Field Summary

Fields inherited from class me.hackware.api.setting.Setting

value

Constructor Summary

Constructors

Constructor	Description
EnumSetting(String name)
EnumSetting(String name, E defaultValue)
EnumSetting(String name, String description)
EnumSetting(String name, String description, E defaultValue)

Method Summary

Modifier and Type	Method	Description
int	choiceCount()	Number of selectable options.
int	choiceIndex()	Index of the currently-selected option, or -1 if none.
String	choiceKey(int index)	Stable persistence key for the option at index (slugged by the config layer).
String	choiceLabel(int index)	Human-readable label for the option at index.
void	choiceSelect(int index)	Select the option at index.
void	cycle()
EnumSetting<E>	defaultValue(E defaultValue)
EnumSetting<E>	description(String description)
EnumSetting<E>	displayName(String displayName)
Class<E>	getEnumClass()
List<E>	getValues()
EnumSetting<E>	group(String group)
EnumSetting<E>	onChanged(Runnable callback)
void	selectByIndex(int index)	Select a value by its ordinal index within the enum's values list.
EnumSetting<E>	visible(boolean visible)
EnumSetting<E>	visible(BooleanSupplier visible)

Methods inherited from class me.hackware.api.setting.ChoiceSetting

choiceCurrentLabel, choiceCycle

Methods inherited from class me.hackware.api.setting.Setting

get, getDefaultValue, getDescription, getDisplayName, getGroup, getName, getOwner, isBulkLoading, isVisible, setBulkLoadProbe, setOwner, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

EnumSetting

public EnumSetting(String name)

EnumSetting

public EnumSetting(String name,
 String description)

EnumSetting

public EnumSetting(String name,
 E defaultValue)

EnumSetting

public EnumSetting(String name,
 String description,
 E defaultValue)

Method Details

defaultValue

public EnumSetting<E> defaultValue(E defaultValue)

Overrides:

defaultValue in class Setting<E extends Enum<E>>

displayName

public EnumSetting<E> displayName(String displayName)

Overrides:

displayName in class Setting<E extends Enum<E>>

description

public EnumSetting<E> description(String description)

Overrides:

description in class Setting<E extends Enum<E>>

group

public EnumSetting<E> group(String group)

Overrides:

group in class Setting<E extends Enum<E>>

visible

public EnumSetting<E> visible(boolean visible)

Overrides:

visible in class Setting<E extends Enum<E>>

visible

public EnumSetting<E> visible(BooleanSupplier visible)

Overrides:

visible in class Setting<E extends Enum<E>>

onChanged

public EnumSetting<E> onChanged(Runnable callback)

Overrides:

onChanged in class Setting<E extends Enum<E>>

getEnumClass

public Class<E> getEnumClass()

getValues

public List<E> getValues()

cycle

public void cycle()

selectByIndex

public void selectByIndex(int index)

Select a value by its ordinal index within the enum's values list.

choiceCount

public int choiceCount()

Description copied from class: ChoiceSetting

Number of selectable options.

Specified by:

choiceCount in class ChoiceSetting<E extends Enum<E>>

choiceLabel

public String choiceLabel(int index)

Description copied from class: ChoiceSetting

Human-readable label for the option at index.

Specified by:

choiceLabel in class ChoiceSetting<E extends Enum<E>>

choiceKey

public String choiceKey(int index)

Description copied from class: ChoiceSetting

Stable persistence key for the option at index (slugged by the config layer).

Specified by:

choiceKey in class ChoiceSetting<E extends Enum<E>>

choiceIndex

public int choiceIndex()

Description copied from class: ChoiceSetting

Index of the currently-selected option, or -1 if none.

Specified by:

choiceIndex in class ChoiceSetting<E extends Enum<E>>

choiceSelect

public void choiceSelect(int index)

Description copied from class: ChoiceSetting

Select the option at index.

Specified by:

choiceSelect in class ChoiceSetting<E extends Enum<E>>