Package net.ixdarklord.coolcatcore.internal.config

Class ConfigValueImpl<T>

java.lang.Object

net.ixdarklord.coolcatcore.internal.config.ConfigNodeImpl

net.ixdarklord.coolcatcore.internal.config.ConfigValueImpl<T>

All Implemented Interfaces:

Supplier<T>, ConfigNode, ConfigValue<T>

public final class ConfigValueImpl<T>
extends ConfigNodeImpl
implements ConfigValue<T>

Nested Class Summary

Nested classes/interfaces inherited from interface net.ixdarklord.coolcatcore.api.config.ConfigValue

ConfigValue.ChangeListener<T>

Constructor Summary

Constructors

Constructor	Description
ConfigValueImpl(String key, ConfigGroupImpl parent, List<String> comment, @Nullable String translationKey, boolean hidden, ConfigType<T> type, T defaultValue, RestartRequirement restart, boolean synced, StartupSync startupSync, List<String> aliases, List<Function<T,net.minecraft.network.chat.Component>> validators, @Nullable ConfigDependency<?> dependency)

Method Summary

Modifier and Type	Method	Description
void	addListener(ConfigValue.ChangeListener<T> listener)	Called on the thread that changed the value, after it changed.
List<String>	aliases()	The old keys (or dotted paths from the root) this value is still read from, for renamed or moved settings.
ValidationResult<T>	decode(com.google.gson.JsonElement json)
Optional<ConfigDependency<?>>	dependency()	The value this one depends on, if it was built with enabledWhen.
com.google.gson.JsonElement	encode(T value)
com.google.gson.JsonElement	encodeCurrent()
com.google.gson.JsonElement	encodeUnchecked(Object value)
T	get()	The current value.
T	getDefault()
T	getStored()	The value in the file.
boolean	isSynced()	Whether a synced config sends this value to clients.
boolean	removeListener(ConfigValue.ChangeListener<T> listener)
RestartRequirement	restartRequirement()
boolean	sameValue(Object first, Object second)
void	set(T value)	Changes the value in memory and notifies listeners; Config.save() writes it.
StartupSync	startupSync()	How a synced ConfigScope.STARTUP value is reconciled with the server's; ignored by other scopes.
String	toString()
ConfigType<T>	type()
ValidationResult<T>	validate(T value)	Checks a value against the type and the entry's own validators, without setting it.
ValidationResult<T>	validateUnchecked(Object value)	Validates a value of unknown type, as the config screen and network hand them over.

Methods inherited from class net.ixdarklord.coolcatcore.internal.config.ConfigNodeImpl

comment, config, configOrNull, displayName, isHidden, key, parent, path, prettify, translationKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ixdarklord.coolcatcore.api.config.ConfigNode

comment, config, displayName, isHidden, key, parent, path, translationKey

Methods inherited from interface net.ixdarklord.coolcatcore.api.config.ConfigValue

isActive, isDefault, isRestartPending, reset

Constructor Details

ConfigValueImpl

public ConfigValueImpl(String key,
 ConfigGroupImpl parent,
 List<String> comment,
 @Nullable
 @Nullable String translationKey,
 boolean hidden,
 ConfigType<T> type,
 T defaultValue,
 RestartRequirement restart,
 boolean synced,
 StartupSync startupSync,
 List<String> aliases,
 List<Function<T,net.minecraft.network.chat.Component>> validators,
 @Nullable
 @Nullable ConfigDependency<?> dependency)

Method Details

get

public T get()

Description copied from interface: ConfigValue

The current value.

Specified by:

get in interface ConfigValue<T>

Specified by:

get in interface Supplier<T>

getStored

public T getStored()

Description copied from interface: ConfigValue

The value in the file. It equals ConfigValue.get() except for a ConfigScope.STARTUP value changed since the game started: get() keeps the value the game started with, and this one applies after a restart.

Specified by:

getStored in interface ConfigValue<T>

set

public void set(T value)

Description copied from interface: ConfigValue

Changes the value in memory and notifies listeners; Config.save() writes it. A value the type corrects (a number out of range, say) is stored corrected. A ConfigScope.STARTUP value only changes its stored value, for the next start.

Specified by:

set in interface ConfigValue<T>

validate

public ValidationResult<T> validate(T value)

Description copied from interface: ConfigValue

Checks a value against the type and the entry's own validators, without setting it.

Specified by:

validate in interface ConfigValue<T>

validateUnchecked

public ValidationResult<T> validateUnchecked(Object value)

Validates a value of unknown type, as the config screen and network hand them over.

decode

public ValidationResult<T> decode(com.google.gson.JsonElement json)

encode

public com.google.gson.JsonElement encode(T value)

encodeCurrent

public com.google.gson.JsonElement encodeCurrent()

encodeUnchecked

public com.google.gson.JsonElement encodeUnchecked(Object value)

sameValue

public boolean sameValue(Object first,
 Object second)

getDefault

public T getDefault()

Specified by:

getDefault in interface ConfigValue<T>

type

public ConfigType<T> type()

Specified by:

type in interface ConfigValue<T>

restartRequirement

public RestartRequirement restartRequirement()

Specified by:

restartRequirement in interface ConfigValue<T>

isSynced

public boolean isSynced()

Description copied from interface: ConfigValue

Whether a synced config sends this value to clients. Off for server secrets (a webhook URL, a password), which stay on the server and can't be edited from a client.

Specified by:

isSynced in interface ConfigValue<T>

startupSync

public StartupSync startupSync()

Description copied from interface: ConfigValue

How a synced ConfigScope.STARTUP value is reconciled with the server's; ignored by other scopes.

Specified by:

startupSync in interface ConfigValue<T>

aliases

public List<String> aliases()

Description copied from interface: ConfigValue

The old keys (or dotted paths from the root) this value is still read from, for renamed or moved settings.

Specified by:

aliases in interface ConfigValue<T>

dependency

public Optional<ConfigDependency<?>> dependency()

Description copied from interface: ConfigValue

The value this one depends on, if it was built with enabledWhen.

Specified by:

dependency in interface ConfigValue<T>

addListener

public void addListener(ConfigValue.ChangeListener<T> listener)

Description copied from interface: ConfigValue

Called on the thread that changed the value, after it changed.

Specified by:

addListener in interface ConfigValue<T>

removeListener

public boolean removeListener(ConfigValue.ChangeListener<T> listener)

Specified by:

removeListener in interface ConfigValue<T>

toString

public String toString()

Overrides:

toString in class Object