ConfigurationDataRetriever (Confectory Core 1.0.1 API)

Type Parameters:

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

All Known Subinterfaces:

ConfigurationHelper<T>

All Known Implementing Classes:

BasicConfigurationHelper, BeanConfigurationHelper, Configuration, GenericJsonConfigurationHelper, NullConfigurationHelper, PropertiesConfigurationHelper, SmartJsonConfigurationHelper
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`getBean()` Returns the configuration bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
`Boolean`	`getBoolean(String key)` Returns the `Boolean` object associated with the specified `key`.
`Double`	`getDouble(String key)` Returns the `Double` object associated with the specified `key`.
`Integer`	`getInteger(String key)` Returns the `Integer` object associated with the specified `key`.
`Long`	`getLong(String key)` Returns the `Long` object associated with the specified `key`.
`Boolean`	`getMandatoryBoolean(String key)` Returns the `Boolean` object associated with the specified `key`, throwing an exception if not found.
`Double`	`getMandatoryDouble(String key)` Returns the `Double` object associated with the specified `key`, throwing an exception if not found.
`Integer`	`getMandatoryInteger(String key)` Returns the `Integer` object associated with the specified `key`, throwing an exception if not found.
`Long`	`getMandatoryLong(String key)` Returns the `Long` object associated with the specified `key`, throwing an exception if not found.
`String`	`getMandatoryString(String key)` Returns the `String` object associated with the specified `key`, throwing an exception if not found.
`String`	`getString(String key)` Returns the `String` object associated with the specified `key`.

- Method Detail
  - getBean
```
T getBean()
```
    Returns the configuration bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
    
    Returns:
    
    the configuration bean (Note: it can be null if the Configuration is marked as optional)
  - getBoolean
```
Boolean getBoolean(String key)
```
    Returns the Boolean object associated with the specified key.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the Boolean object associated with the specified key; null if not found
  - getInteger
```
Integer getInteger(String key)
```
    Returns the Integer object associated with the specified key.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    the Integer object associated with the specified key; null if not found
    
    Throws:
    
    NumberFormatException - if the value is not a parsable int.
  - getLong
```
Long getLong(String key)
```
    Returns the Long object associated with the specified key.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    the Long object associated with the specified key; null if not found
    
    Throws:
    
    NumberFormatException - if the value is not a parsable long.
  - getDouble
```
Double getDouble(String key)
```
    Returns the Double object associated with the specified key.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    the Double object associated with the specified key; null if not found
    
    Throws:
    
    NumberFormatException - if the value is not a parsable double.
  - getString
```
String getString(String key)
```
    Returns the String object associated with the specified key.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the String object associated with the specified key; null if not found
  - getMandatoryBoolean
```
Boolean getMandatoryBoolean(String key)
```
    Returns the Boolean object associated with the specified key, throwing an exception if not found.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the Boolean value associated with the specified key; never null
    
    Throws:
    
    ConfigurationException - if the specified key (or path) is not found.
    
    Since:
    
    0.4.0
  - getMandatoryInteger
```
Integer getMandatoryInteger(String key)
```
    Returns the Integer object associated with the specified key, throwing an exception if not found.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the Integer object associated with the specified key; never null
    
    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 object associated with the specified key, throwing an exception if not found.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the Long object associated with the specified key; never null
    
    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 object associated with the specified key, throwing an exception if not found.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the Double object associated with the specified key; never null
    
    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 object associated with the specified key, throwing an exception if not found.
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    the String object associated with the specified key; never null
    
    Throws:
    
    ConfigurationException - if the specified key (or path) is not found.
    
    Since:
    
    0.4.0

Interface ConfigurationDataRetriever<T>

Method Summary

Method Detail

getBean

getBoolean

getInteger

getLong

getDouble

getString

getMandatoryBoolean

getMandatoryInteger

getMandatoryLong

getMandatoryDouble

getMandatoryString