Package me.datafox.dfxengine.text.api

Interface TextConfiguration

All Known Implementing Classes:

TextConfigurationImpl

public interface TextConfiguration

Configuration used by NumberFormatters, NumberSuffixFormatters, Texts and the TextFactory.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all entries from this configuration.
<T> void	clear(ConfigurationKey<T> key)
TextConfiguration	copy()
<T> T	get(ConfigurationKey<T> key)
Map<ConfigurationKey<?>,ConfigurationValue<?>>	getAll()
TextFactory	getFactory()
<T> void	set(ConfigurationKey<T> key, ConfigurationValue<T> value)
<T> void	set(ConfigurationKey<T> key, T value)
void	set(TextConfiguration configuration)	Applies all entries of the provided configuration to this one, overwriting any existing entries if present.

Method Details

getFactory

TextFactory getFactory()

Returns:

TextFactory associated with this configuration

set

<T> void set(ConfigurationKey<T> key,
 ConfigurationValue<T> value)

Type Parameters:

T - type of the object returned by the ConfigurationValue

Parameters:

key - ConfigurationKey to be used

value - ConfigurationValue to be used

set

<T> void set(ConfigurationKey<T> key,
 T value)

Type Parameters:

T - type of the object

Parameters:

key - ConfigurationKey to be used

value - object to be used

set

void set(TextConfiguration configuration)

Applies all entries of the provided configuration to this one, overwriting any existing entries if present.

Parameters:

configuration - TextConfiguration to be applied

get

<T> T get(ConfigurationKey<T> key)

Type Parameters:

T - type of the object

Parameters:

key - ConfigurationKey to be used

Returns:

object associated with the key, or the default value if none is present

getAll

Map<ConfigurationKey<?>,ConfigurationValue<?>> getAll()

Returns:

Unmodifiable Map containing all entries of this configuration

clear

<T> void clear(ConfigurationKey<T> key)

Type Parameters:

T - type of the value

Parameters:

key - ConfigurationKey associated with the value to be cleared

clear

void clear()

Clears all entries from this configuration.

copy

TextConfiguration copy()

Returns:

unique configuration instance containing all entries of this configuration