tech.ferus.util.config

Class ConfigKey<T>

java.lang.Object

tech.ferus.util.config.ConfigKey<T>

Type Parameters:

T - the type of object that this ConfigKey should reference

public class ConfigKey<T>
extends java.lang.Object

An object designed to allow easy data-grabbing from a ConfigFile.

Field Summary

Fields

Modifier and Type	Field and Description
private T	def
private java.lang.Object[]	key The path from root to node.
private static org.slf4j.Logger	LOGGER The ConfigKeys logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConfigKey(java.lang.Object[] key) Constructs a new ConfigKey.
private	ConfigKey(java.lang.Object[] key, T def) Constructs a new ConfigKey.

Method Summary

Modifier and Type	Method and Description
T	get(ConfigFile config) Returns the value stored in configuration for this key.
T	get(ConfigFile config, T def) Returns the value stored in configuration this key.
static <T> ConfigKey<T>	of(java.lang.Object... key) Convenience method to construct a new ConfigKey.
static <T> ConfigKey<T>	of(java.lang.Object key) Convenience method to construct a new ConfigKey.
static <T> ConfigKey<T>	of(T def, java.lang.Object... key) Convenience method to construct a new ConfigKey.
static <T> ConfigKey<T>	of(T def, java.lang.Object key) Convenience method to construct a new ConfigKey.
boolean	set(ConfigFile config, T value) Sets and saves a value for the node located at the path for this key.
void	setWithException(ConfigFile config, T value) Sets and saves a value for the node located at the path for this key.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

The ConfigKeys logger.

key

@Nonnull
private final java.lang.Object[] key

The path from root to node.

def

@Nullable
private final T def

Constructor Detail

ConfigKey

private ConfigKey(@Nonnull
                  java.lang.Object[] key)

Constructs a new ConfigKey.

Note: Default value will be null.

Parameters:

key - the path to the node on any level

ConfigKey

private ConfigKey(@Nonnull
                  java.lang.Object[] key,
                  @Nullable
                  T def)

Constructs a new ConfigKey.

Parameters:

key - the path to the node on any level

def - the default value to be returned if an existing value cannot be obtained

Method Detail

get

@Nullable
public T get(@Nonnull
                       ConfigFile config)

Returns the value stored in configuration for this key.

If the path doesn't exist, there is no value, or an exception occurs, the default value for this ConfigKey will be returned.

Parameters:

config - the ConfigFile to look through

Returns:

the value stored in configuration for this key

get

@Nullable
public T get(@Nonnull
                       ConfigFile config,
                       @Nullable
                       T def)

Returns the value stored in configuration this key.

Note: If this ConfigKey has a default value set, this method will ignore it and use the provided default value.

Parameters:

config - the ConfigFile to look through

def - the default value to be returned if an existing value cannot be obtained

Returns:

the value stored in configuration for this key, or default

setWithException

public void setWithException(@Nullable
                             ConfigFile config,
                             @Nullable
                             T value)
                      throws java.io.IOException

Sets and saves a value for the node located at the path for this key.

Parameters:

config - the ConfigFile to save to

value - the value to change the node to

Throws:

java.io.IOException - if the configuration file cannot be saved to

set

public boolean set(@Nullable
                   ConfigFile config,
                   @Nullable
                   T value)

Sets and saves a value for the node located at the path for this key.

Parameters:

config - the ConfigFile to save to

value - the value to change the node to

Returns:

true if the configuration was saved; false otherwise

of

public static <T> ConfigKey<T> of(java.lang.Object key)

Convenience method to construct a new ConfigKey.

The purpose of this method is purely to reduce new ConfigKey(new Object[]{"string"}); to ConfigKey.of("string");.

Type Parameters:

T - the type of object that the ConfigKey should reference

Parameters:

key - the path to the node on the top level

Returns:

a new ConfigKey with the specified path

of

public static <T> ConfigKey<T> of(java.lang.Object... key)

Convenience method to construct a new ConfigKey.

The purpose of this method is purely to reduce new ConfigKey(new Object[]{"string"}); to ConfigKey.of("string");.

Type Parameters:

T - the type of object that the ConfigKey should reference

Parameters:

key - the path to the node on any level

Returns:

a new ConfigKey with the specified path

of

public static <T> ConfigKey<T> of(T def,
                                  java.lang.Object key)

Convenience method to construct a new ConfigKey.

The purpose of this method is purely to reduce new ConfigKey(new Object[]{"string"}); to ConfigKey.of("string");.

Type Parameters:

T - the type of object that the ConfigKey should reference

Parameters:

def - the default value for this key

key - the path to the node on the top level

Returns:

a new ConfigKey with the specified path

of

public static <T> ConfigKey<T> of(T def,
                                  java.lang.Object... key)

Convenience method to construct a new ConfigKey.

The purpose of this method is purely to reduce new ConfigKey(new Object[]{"string"}); to ConfigKey.of("string");.

Type Parameters:

T - the type of object that the ConfigKey should reference

Parameters:

def - the default value for this key

key - the path to the node on any level

Returns:

a new ConfigKey with the specified path