Package me.hackware.api.setting

Class Setting<T>

java.lang.Object

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

Direct Known Subclasses:

ActionSetting, BooleanSetting, ChoiceSetting, ColorSetting, FilterSetting, KeybindSetting, ListSetting, MapSetting, MultiSelectSetting, NumberSetting, StringSetting

public abstract class Setting<T>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected T	value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Setting(String name)
protected	Setting(String name, String description)
protected	Setting(String name, String description, T defaultValue)
protected	Setting(String name, T defaultValue)

Method Summary

Modifier and Type	Method	Description
Setting<T>	defaultValue(T defaultValue)
Setting<T>	description(String description)
Setting<T>	displayName(String displayName)
T	get()
T	getDefaultValue()
String	getDescription()
String	getDisplayName()
String	getGroup()
String	getName()
SettingContainer	getOwner()
Setting<T>	group(String group)
static boolean	isBulkLoading()	True while the config layer is bulk-applying values from disk.
boolean	isVisible()
Setting<T>	onChanged(Runnable callback)
static void	setBulkLoadProbe(BooleanSupplier probe)	Installed once by the config layer; the API ships a never-loading default.
void	setOwner(SettingContainer owner)
void	setValue(T value)
Setting<T>	visible(boolean visible)
Setting<T>	visible(BooleanSupplier visible)

Methods inherited from class java.lang.Object

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

Field Details

value

protected T value

Constructor Details

Setting

protected Setting(String name)

Setting

protected Setting(String name,
 String description)

Setting

protected Setting(String name,
 T defaultValue)

Setting

protected Setting(String name,
 String description,
 T defaultValue)

Method Details

setBulkLoadProbe

public static void setBulkLoadProbe(BooleanSupplier probe)

Installed once by the config layer; the API ships a never-loading default.

isBulkLoading

public static boolean isBulkLoading()

True while the config layer is bulk-applying values from disk.

displayName

public Setting<T> displayName(String displayName)

description

public Setting<T> description(String description)

group

public Setting<T> group(String group)

defaultValue

public Setting<T> defaultValue(T defaultValue)

visible

public Setting<T> visible(boolean visible)

visible

public Setting<T> visible(BooleanSupplier visible)

onChanged

public Setting<T> onChanged(Runnable callback)

getName

public String getName()

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()

getGroup

public String getGroup()

getDefaultValue

public T getDefaultValue()

get

public T get()

isVisible

public boolean isVisible()

setValue

public void setValue(T value)

getOwner

public SettingContainer getOwner()

setOwner

public void setOwner(SettingContainer owner)