Interface Configuration

All Known Implementing Classes:

ConfigurationProvider, MapConfiguration

public interface Configuration

Application configuration. Provides read-only or read-write access to key-value pairs (either as Keys or as arbitrary strings) in some kind of underlying storage.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any key-value pairs from the instance (but not its persistent store, if available).
default void	clearProperty(Key key)
void	clearProperty(String key)	Removes a single key-value pair from the instance (but not its persistent store, if available).
static Configuration	forApplication()
default boolean	getBoolean(Key key)
default boolean	getBoolean(Key key, boolean defaultValue)
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean defaultValue)
default double	getDouble(Key key)
default double	getDouble(Key key, double defaultValue)
double	getDouble(String key)
double	getDouble(String key, double defaultValue)
Optional<Path>	getFile()
default float	getFloat(Key key)
default float	getFloat(Key key, float defaultValue)
float	getFloat(String key)
float	getFloat(String key, float defaultValue)
default int	getInt(Key key)
default int	getInt(Key key, int defaultValue)
int	getInt(String key)
int	getInt(String key, int defaultValue)
Iterator<String>	getKeys()
default long	getLong(Key key)
default long	getLong(Key key, long defaultValue)
long	getLong(String key)
long	getLong(String key, long defaultValue)
default long	getLongBytes(Key key)
default long	getLongBytes(Key key, long defaultValue)
default long	getLongBytes(String key)
default long	getLongBytes(String key, long defaultValue)
default Object	getProperty(Key key)
Object	getProperty(String key)
default String	getString(Key key)
default String	getString(Key key, String defaultValue)
String	getString(String key)
String	getString(String key, String defaultValue)
void	reload()	Reloads the configuration from its persistent store.
default void	setProperty(Key key, Object value)
void	setProperty(String key, Object value)
default Map<String,Object>	toMap()	This default implementation uses the Iterator returned by getKeys() in conjunction with getProperty(String) to build a map.

Method Details

forApplication

static Configuration forApplication()

Returns:

Global application configuration instance.

clear

void clear()

Clears any key-value pairs from the instance (but not its persistent store, if available).

clearProperty

default void clearProperty(Key key)

See Also:

• clearProperty(String)

clearProperty

void clearProperty(String key)

Removes a single key-value pair from the instance (but not its persistent store, if available).

Parameters:

key - Key to remove.

getBoolean

default boolean getBoolean(Key key)

See Also:

• getBoolean(String)

getBoolean

boolean getBoolean(String key)

Throws:

NoSuchElementException

NumberFormatException

getBoolean

default boolean getBoolean(Key key,
 boolean defaultValue)

See Also:

• getBoolean(String, boolean)

getBoolean

boolean getBoolean(String key,
 boolean defaultValue)

Returns:

Boolean value corresponding to the given key, or the given default value if the target value is null or cannot be coerced to a boolean.

getDouble

default double getDouble(Key key)

Throws:

NoSuchElementException

NumberFormatException

getDouble

double getDouble(String key)

Throws:

NoSuchElementException

NumberFormatException

getDouble

default double getDouble(Key key,
 double defaultValue)

See Also:

• getDouble(String, double)

getDouble

double getDouble(String key,
 double defaultValue)

Returns:

Double value corresponding to the given key, or the given default value if the target value is null or cannot be coerced to a double.

getFile

Optional<Path> getFile()

Returns:

The file backing the instance, if any.

getFloat

default float getFloat(Key key)

See Also:

• getFloat(String)

getFloat

float getFloat(String key)

Throws:

NoSuchElementException

NumberFormatException

getFloat

default float getFloat(Key key,
 float defaultValue)

See Also:

• getFloat(String, float)

getFloat

float getFloat(String key,
 float defaultValue)

Returns:

Float value corresponding to the given key, or the given default value if the target value is null or cannot be coerced to a float.

getInt

default int getInt(Key key)

See Also:

• getInt(String)

getInt

int getInt(String key)

Throws:

NoSuchElementException

NumberFormatException

getInt

default int getInt(Key key,
 int defaultValue)

See Also:

• getInt(String, int)

getInt

int getInt(String key,
 int defaultValue)

Returns:

Int value corresponding to the given key, or the given default value if the target value is null or cannot be coerced to an int.

getKeys

Iterator<String> getKeys()

Returns:

All keys contained in the configuration.

getLong

default long getLong(Key key)

See Also:

• getLong(String)

getLong

long getLong(String key)

Throws:

NoSuchElementException

NumberFormatException

getLong

default long getLong(Key key,
 long defaultValue)

See Also:

• getLong(String, long)

getLong

long getLong(String key,
 long defaultValue)

Returns:

Long value corresponding to the given key, or the given default value if the target value is null or cannot be coerced to a long.

getLongBytes

default long getLongBytes(Key key)

See Also:

• getLongBytes(String)

getLongBytes

default long getLongBytes(String key)

Throws:

NoSuchElementException

NumberFormatException

getLongBytes

default long getLongBytes(Key key,
 long defaultValue)

See Also:

• getLongBytes(String, long)

getLongBytes

default long getLongBytes(String key,
 long defaultValue)

Returns:

Byte size corresponding to the given key, or the given default value if the target value is null or cannot be coerced to a byte size.

See Also:

• which is used to parse the string.

getProperty

default Object getProperty(Key key)

See Also:

• getProperty(String)

getProperty

Object getProperty(String key)

Returns:

Object value corresponding to the given key, or null if not set.

getString

default String getString(Key key)

See Also:

• getString(String)

getString

String getString(String key)

Returns:

String value corresponding to the given key, or null if not set.

getString

default String getString(Key key,
 String defaultValue)

See Also:

• getString(String, String)

getString

String getString(String key,
 String defaultValue)

Returns:

String value corresponding to the given key, or the given default value if the target value is null.

reload

void reload()
     throws IOException,
ConfigurationException

Reloads the configuration from its persistent store.

Throws:

IOException - if there is a physical problem reloading the configuration.

ConfigurationException - if there is a logical problem reloading the configuration.

setProperty

default void setProperty(Key key,
 Object value)

See Also:

• setProperty(String, Object)

setProperty

void setProperty(String key,
 Object value)

toMap

default Map<String,Object> toMap()

This default implementation uses the Iterator returned by getKeys() in conjunction with getProperty(String) to build a map. Implementations should override if they can do it more efficiently.

Returns:

Configuration keys and values in a read-only map.