Package me.hsgamer.hscore.config.path

Class BaseConfigPath<T>

java.lang.Object

me.hsgamer.hscore.config.path.BaseConfigPath<T>

Type Parameters:

T - the type of the value

All Implemented Interfaces:

ConfigPath<T>

Direct Known Subclasses:

BooleanConfigPath, DoubleConfigPath, FloatConfigPath, IntegerConfigPath, LongConfigPath, SimpleConfigPath, StringConfigPath

public class BaseConfigPath<T>
extends Object
implements ConfigPath<T>

A simple config path

Constructor Summary

Constructors

Constructor	Description
BaseConfigPath(@NotNull String path, T def, @NotNull Function<Object,T> typeConverter)	Create a config path

Method Summary

Modifier and Type	Method	Description
@Nullable Config	getConfig()	Get the config
@NotNull String	getPath()	Get the path to the value
T	getValue()	Get the value
T	getValue(@NotNull Config config)	Get the value from the config.
void	migrateConfig(@NotNull Config config)	Manually update the config (Mainly used when updating new settings)
void	setConfig(@NotNull Config config)	Set the config.
void	setValue(T value)	Set the value
void	setValue(T value, @NotNull Config config)	Set the value to the config.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.hsgamer.hscore.config.path.ConfigPath

reload, setAndSave, setAndSave

Constructor Details

BaseConfigPath

public BaseConfigPath(@NotNull
 @NotNull String path,
 @Nullable
 T def,
 @NotNull
 @NotNull Function<Object,T> typeConverter)

Create a config path

Parameters:

path - the path to the value

def - the default value if it's not found

typeConverter - how to convert the raw object to the needed type of value

Method Details

getValue

public T getValue()

Description copied from interface: ConfigPath

Get the value

Specified by:

getValue in interface ConfigPath<T>

Returns:

the value

setValue

public void setValue(@Nullable
 T value)

Description copied from interface: ConfigPath

Set the value

Specified by:

setValue in interface ConfigPath<T>

Parameters:

value - the value

getValue

public T getValue(@NotNull
 @NotNull Config config)

Description copied from interface: ConfigPath

Get the value from the config. This is used to get the value from multiple configs.

Specified by:

getValue in interface ConfigPath<T>

Parameters:

config - the config

Returns:

the value

setValue

public void setValue(@Nullable
 T value,
 @NotNull
 @NotNull Config config)

Description copied from interface: ConfigPath

Set the value to the config. This is used to set the value to multiple configs.

Specified by:

setValue in interface ConfigPath<T>

Parameters:

value - the value

config - the config

getPath

@NotNull
public @NotNull String getPath()

Description copied from interface: ConfigPath

Get the path to the value

Specified by:

getPath in interface ConfigPath<T>

Returns:

the path

getConfig

@Nullable
public @Nullable Config getConfig()

Description copied from interface: ConfigPath

Get the config

Specified by:

getConfig in interface ConfigPath<T>

Returns:

the config

setConfig

public void setConfig(@NotNull
 @NotNull Config config)

Description copied from interface: ConfigPath

Set the config.

Specified by:

setConfig in interface ConfigPath<T>

Parameters:

config - the config

migrateConfig

public void migrateConfig(@NotNull
 @NotNull Config config)

Description copied from interface: ConfigPath

Manually update the config (Mainly used when updating new settings)

Specified by:

migrateConfig in interface ConfigPath<T>

Parameters:

config - the config