net.obvj.confectory

Interface ConfigurationDataRetriever<T>

Type Parameters:

T - the target type which configuration data is to be retrieved

All Known Subinterfaces:

ConfigurationHelper<T>

All Known Implementing Classes:

AbstractBasicConfigurationHelper, BasicConfigurationHelper, BeanConfigurationHelper, Configuration, GenericJsonConfigurationHelper, NullConfigurationHelper, PropertiesConfigurationHelper

public interface ConfigurationDataRetriever<T>

A base interface for objects that retrieve configuration data.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type	Method and Description
Optional<T>	getBean() Returns the target configuration object used by this data retriever, typically for manual handling and/or troubleshooting purposes.
boolean	getBoolean(String key) Returns the boolean value associated with the specified key.
double	getDouble(String key) Returns the double value associated with the specified key.
int	getInt(String key) Returns the int value associated with the specified key.
long	getLong(String key) Returns the long value associated with the specified key.
boolean	getMandatoryBoolean(String key) Returns the boolean value associated with the specified key.
double	getMandatoryDouble(String key) Returns the double value associated with the specified key.
int	getMandatoryInt(String key) Returns the int value associated with the specified key.
long	getMandatoryLong(String key) Returns the long value associated with the specified key.
String	getMandatoryString(String key) Returns the String value associated with the specified key.
String	getString(String key) Returns the String value associated with the specified key.

Method Detail

getBean

Optional<T> getBean()

Returns the target configuration object used by this data retriever, typically for manual handling and/or troubleshooting purposes.

Returns:

an Optional, possibly containing the target configuration object

getBoolean

boolean getBoolean(String key)

Returns the boolean value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the boolean value associated with the specified key

getInt

int getInt(String key)

Returns the int value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the int value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable int.

getLong

long getLong(String key)

Returns the long value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the long value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable long.

getDouble

double getDouble(String key)

Returns the double value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the double value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable double.

getString

String getString(String key)

Returns the String value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the String value associated with the specified key

getMandatoryBoolean

boolean getMandatoryBoolean(String key)

Returns the boolean value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the boolean value associated with the specified key

Throws:

ConfigurationException - if the specified key (or path) is not found.

Since:

0.4.0

getMandatoryInt

int getMandatoryInt(String key)

Returns the int value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the int value associated with the specified key

Throws:

ConfigurationException - if the specified key (or path) is not found.

NumberFormatException - if the value is not a parsable int.

Since:

0.4.0

getMandatoryLong

long getMandatoryLong(String key)

Returns the long value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the long value associated with the specified key

Throws:

ConfigurationException - if the specified key (or path) is not found.

NumberFormatException - if the value is not a parsable long.

Since:

0.4.0

getMandatoryDouble

double getMandatoryDouble(String key)

Returns the double value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the double value associated with the specified key

Throws:

ConfigurationException - if the specified key (or path) is not found.

NumberFormatException - if the value is not a parsable double.

Since:

0.4.0

getMandatoryString

String getMandatoryString(String key)

Returns the String value associated with the specified key.

Parameters:

key - the property key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the String value associated with the specified key

Throws:

ConfigurationException - if the specified key (or path) is not found.

Since:

0.4.0