com.alanbuttars.commons.config

Class ConfigurationPropertiesImpl

java.lang.Object

com.alanbuttars.commons.config.ConfigurationAbstractImpl<Properties>

com.alanbuttars.commons.config.ConfigurationPropertiesImpl

All Implemented Interfaces:

Configuration<Properties>

public class ConfigurationPropertiesImpl
extends ConfigurationAbstractImpl<Properties>

Configuration implementation used for Java .properties files

Author:

Alan Buttars

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesImpl(String sourceId, File configFile, EventBus eventBus)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(String key, boolean defaultValue) Retrieves the boolean configuration value associated with the given key, or the defaultValue if no value was configured.
byte	getByte(String key, byte defaultValue) Retrieves the byte configuration value associated with the given key, or the defaultValue if no value was configured.
char	getChar(String key, char defaultValue) Retrieves the char configuration value associated with the given key, or the defaultValue if no value was configured.
double	getDouble(String key, double defaultValue) Retrieves the double configuration value associated with the given key, or the defaultValue if no value was configured.
float	getFloat(String key, float defaultValue) Retrieves the float configuration value associated with the given key, or the defaultValue if no value was configured.
int	getInt(String key, int defaultValue) Retrieves the int configuration value associated with the given key, or the defaultValue if no value was configured.
long	getLong(String key, long defaultValue) Retrieves the long configuration value associated with the given key, or the defaultValue if no value was configured.
short	getShort(String key, short defaultValue) Retrieves the short configuration value associated with the given key, or the defaultValue if no value was configured.
String	getString(String key, String defaultValue) Retrieves the String configuration value associated with the given key, or the defaultValue if no value was configured.
protected String	getValue(String key) Fetches the configuration value.
<V> V	getValue(String key, Function<String,V> valueMappingFunction) Retrieves the configuration value associated with the given key by transforming the value using the valueMappingFunction.
Properties	load(File configFile) Loads the configuration object from the configuration file.

Methods inherited from class com.alanbuttars.commons.config.ConfigurationAbstractImpl

getEventBus, getSourceId, getValue, init, onFileEvent, onFileEventMatch, reload, whenConfigFileCreated, whenConfigFileDeleted, whenConfigFileUpdated

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPropertiesImpl

public ConfigurationPropertiesImpl(String sourceId,
                           File configFile,
                           EventBus eventBus)
                            throws IOException

Throws:

IOException

Method Detail

getByte

public byte getByte(String key,
           byte defaultValue)

Retrieves the byte configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getShort

public short getShort(String key,
             short defaultValue)

Retrieves the short configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getInt

public int getInt(String key,
         int defaultValue)

Retrieves the int configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getLong

public long getLong(String key,
           long defaultValue)

Retrieves the long configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getFloat

public float getFloat(String key,
             float defaultValue)

Retrieves the float configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getDouble

public double getDouble(String key,
               double defaultValue)

Retrieves the double configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getBoolean

public boolean getBoolean(String key,
                 boolean defaultValue)

Retrieves the boolean configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValueconfig - The default value

getChar

public char getChar(String key,
           char defaultValue)

Retrieves the char configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The default value

getString

public String getString(String key,
               String defaultValue)

Retrieves the String configuration value associated with the given key, or the defaultValue if no value was configured.

Parameters:

key - Non-null configuration key

defaultValue - The nullable default value

getValue

public <V> V getValue(String key,
             Function<String,V> valueMappingFunction)

Retrieves the configuration value associated with the given key by transforming the value using the valueMappingFunction.

Type Parameters:

V -

Parameters:

key - Non-null configuration key

valueMappingFunction - Non-null mapping function transforming the configuration value to the desired type

getValue

protected String getValue(String key)

Fetches the configuration value.

Parameters:

key - Non-null key

Returns:

Null if no configuration value exists

load

public Properties load(File configFile)
                throws IOException

Description copied from interface: Configuration

Loads the configuration object from the configuration file.

Parameters:

configFile - Non-null configuration file

Returns:

Non-null configuration object

Throws:

IOException - On any I/O error while reading the configuration file