Package me.datafox.dfxengine.text.api

Class ConfigurationKey<T>

java.lang.Object

me.datafox.dfxengine.text.api.ConfigurationKey<T>

public final class ConfigurationKey<T>
extends Object

Data class that is used as a key for TextConfiguration. Contains a hidden index to keep the hashcode unique and a default value that is used when the configured value is not set or cannot be obtained.

Constructor Summary

Constructors

Constructor	Description
ConfigurationKey()

Method Summary

Modifier and Type	Method	Description
static <T> ConfigurationKey<T>	of()	Any class calling this method must also call setDefaultValue(Object) on the returned configuration key.
static <T> ConfigurationKey<T>	of(T defaultValue)
void	setDefaultValue(T defaultValue)

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationKey

public ConfigurationKey()

Method Details

setDefaultValue

public void setDefaultValue(T defaultValue)

Parameters:

defaultValue - value to be set as the default value

Throws:

UnsupportedOperationException - if the default value has already been set

of

public static <T> ConfigurationKey<T> of(T defaultValue)

Type Parameters:

T - type of the value of this configuration key

Parameters:

defaultValue - default value for the configuration key

Returns:

new ConfigurationKey with the specified default value

of

public static <T> ConfigurationKey<T> of()

Any class calling this method must also call setDefaultValue(Object) on the returned configuration key.

Type Parameters:

T - type of the value of this configuration key

Returns:

new ConfigurationKey with the specified default value