Package io.unlaunch

Interface UnlaunchDynamicConfig

public interface UnlaunchDynamicConfig

The main interface for accessing Unlaunch Key-Value configuration data in a read-only fashion

Author:

umermansoor

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(String key)	Checks if the configuration contains the specified key.
boolean	getBoolean(String key)	Gets a boolean associated with the given configuration key.
boolean	getBoolean(String key, boolean defaultValue)	Gets a boolean associated with the given configuration key.
double	getDouble(String key)	Gets a double associated with the given configuration key.
double	getDouble(String key, double defaultValue)	Gets a double associated with the given configuration key.
float	getFloat(String key)	Gets a float associated with the given configuration key.
float	getFloat(String key, float defaultValue)	Gets a float associated with the given configuration key.
int	getInt(String key)	Gets a int associated with the given configuration key.
int	getInt(String key, int defaultValue)	Gets a int associated with the given configuration key.
long	getLong(String key)	Gets a long associated with the given configuration key.
long	getLong(String key, long defaultValue)	Gets a long associated with the given configuration key.
String	getString(String key)	Gets a string associated with the given configuration key.
String	getString(String key, String defaultValue)	Gets a string associated with the given configuration key.
boolean	isEmpty()	Checks if the configuration is empty.
int	size()	Returns the number of keys stored in this configuration.

Method Detail

containsKey

boolean containsKey(String key)

Checks if the configuration contains the specified key.

Parameters:

key - the key whose presence in this configuration is to be tested

Returns:

true if the configuration contains a value for this key, false otherwise

getBoolean

boolean getBoolean(String key)

Gets a boolean associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated boolean.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a Boolean.

getBoolean

boolean getBoolean(String key,
                   boolean defaultValue)

Gets a boolean associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated boolean.

getDouble

double getDouble(String key)

Gets a double associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated double.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a Double

NullPointerException - if the specified key is null

getDouble

double getDouble(String key,
                 double defaultValue)

Gets a double associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated double.

getFloat

float getFloat(String key)

Gets a float associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated float.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a Float.

NullPointerException - if the specified key is null

getFloat

float getFloat(String key,
               float defaultValue)

Gets a float associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated float.

getInt

int getInt(String key)

Gets a int associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated int.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a Integer.

NullPointerException - if the specified key is null

getInt

int getInt(String key,
           int defaultValue)

Gets a int associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated int.

getLong

long getLong(String key)

Gets a long associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated long.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a Long.

NullPointerException - if the specified key is null

getLong

long getLong(String key,
             long defaultValue)

Gets a long associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated long.

getString

String getString(String key)

Gets a string associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated string.

Throws:

UnlaunchConversionException - is thrown if the key maps to an object that is not a String.

NullPointerException - if the specified key is null

getString

String getString(String key,
                 String defaultValue)

Gets a string associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.

Parameters:

key - The configuration key.

defaultValue - The default value.

Returns:

The associated string if key is found and has valid format, default value otherwise.

isEmpty

boolean isEmpty()

Checks if the configuration is empty.

Returns:

true if the configuration contains no property, false otherwise.

size

int size()

Returns the number of keys stored in this configuration.

Returns:

the number of keys stored in this configuration