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, 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	getBooleanProperty(String key) Returns the boolean value associated with the specified key.
double	getDoubleProperty(String key) Returns the double value associated with the specified key.
int	getIntProperty(String key) Returns the int value associated with the specified key.
long	getLongProperty(String key) Returns the long value associated with the specified key.
String	getStringProperty(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

getBooleanProperty

boolean getBooleanProperty(String key)

Returns the boolean value associated with the specified key.

Parameters:

key - the property key

Returns:

the boolean value associated with the specified key

getIntProperty

int getIntProperty(String key)

Returns the int value associated with the specified key.

Parameters:

key - the property key

Returns:

the int value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable int.

getLongProperty

long getLongProperty(String key)

Returns the long value associated with the specified key.

Parameters:

key - the property key

Returns:

the long value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable long.

getDoubleProperty

double getDoubleProperty(String key)

Returns the double value associated with the specified key.

Parameters:

key - the property key

Returns:

the double value associated with the specified key

Throws:

NumberFormatException - if the value is not a parsable double.

getStringProperty

String getStringProperty(String key)

Returns the String value associated with the specified key.

Parameters:

key - the property key

Returns:

the String value associated with the specified key