NullConfigurationHelper (Confectory Core 2.4.0 API)

java.lang.Object
- net.obvj.confectory.internal.helper.NullConfigurationHelper<T>

Type Parameters:

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

All Implemented Interfaces:

ConfigurationDataRetriever<T>, ConfigurationHelper<T>
```
public class NullConfigurationHelper<T>
extends Object
implements ConfigurationHelper<T>
```
A "no-op" Configuration Helper object for situations where an optional Configuration object is not available.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors
Constructor and Description
`NullConfigurationHelper()` Builds a `NullConfigurationHelper`.
`NullConfigurationHelper(ConfigurationHelper<T> originalHelper)` Builds a `NullConfigurationHelper` with a reference to the original/expected `ConfigurationHelper`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfigurationMerger<T>`	`configurationMerger()` Creates the applicable `ConfigurationMerger` object for the type associated with this `ConfigurationHelper`.
`Object`	`get(String key)` Returns the object associated with the specified `key`.
`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`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.obvj.confectory.internal.helper.ConfigurationHelper
newInstance

- Constructor Detail
  - NullConfigurationHelper
```
public NullConfigurationHelper()
```
    Builds a NullConfigurationHelper.
    
    Since:
    
    2.2.0
  - NullConfigurationHelper
```
public NullConfigurationHelper(ConfigurationHelper<T> originalHelper)
```
    Builds a NullConfigurationHelper with a reference to the original/expected ConfigurationHelper.
    
    Parameters:
    
    originalHelper - the initial ConfigurationHelper that should be applied if the actual bean was available
    
    Since:
    
    2.2.0
- Method Detail
  - getBean
```
public T getBean()
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the configuration bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
    
    Specified by:
    
    getBean in interface ConfigurationDataRetriever<T>
    
    Returns:
    
    null, always
  - get
```
public Object get(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    Returns the object associated with the specified key.
    Notes:
    - The actual return type may vary depending on the underlying implementation
    - On a JSON implementation, the return will usually be an array
    Specified by:
    
    get in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    null, always
  - getBoolean
```
public Boolean getBoolean(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Boolean object associated with the specified key.
    
    Specified by:
    
    getBoolean in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    null, always (not to be interpreted as false)
  - getInteger
```
public Integer getInteger(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Integer object associated with the specified key.
    
    Specified by:
    
    getInteger in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    null, always
  - getLong
```
public Long getLong(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Long object associated with the specified key.
    
    Specified by:
    
    getLong in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    null, always
  - getDouble
```
public Double getDouble(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Double object associated with the specified key.
    
    Specified by:
    
    getDouble in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath
    
    Returns:
    
    null, always
  - getString
```
public String getString(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the String object associated with the specified key.
    
    Specified by:
    
    getString in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the object key (some implementations may also accept a path expression, e.g: JSONPath)
    
    Returns:
    
    null, always
  - getMandatoryBoolean
```
public Boolean getMandatoryBoolean(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Boolean object associated with the specified key, throwing an exception if not found.
    
    Specified by:
    
    getMandatoryBoolean in interface ConfigurationDataRetriever<T>
    
    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 - always
  - getMandatoryInteger
```
public Integer getMandatoryInteger(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Integer object associated with the specified key, throwing an exception if not found.
    
    Specified by:
    
    getMandatoryInteger in interface ConfigurationDataRetriever<T>
    
    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 - always
  - getMandatoryLong
```
public Long getMandatoryLong(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Long object associated with the specified key, throwing an exception if not found.
    
    Specified by:
    
    getMandatoryLong in interface ConfigurationDataRetriever<T>
    
    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 - always
  - getMandatoryDouble
```
public Double getMandatoryDouble(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the Double object associated with the specified key, throwing an exception if not found.
    
    Specified by:
    
    getMandatoryDouble in interface ConfigurationDataRetriever<T>
    
    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 - always
  - getMandatoryString
```
public String getMandatoryString(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the String object associated with the specified key, throwing an exception if not found.
    
    Specified by:
    
    getMandatoryString in interface ConfigurationDataRetriever<T>
    
    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 - always
  - configurationMerger
```
public ConfigurationMerger<T> configurationMerger()
```
    Description copied from interface: ConfigurationHelper
    
    Creates the applicable ConfigurationMerger object for the type associated with this ConfigurationHelper.
    
    Specified by:
    
    configurationMerger in interface ConfigurationHelper<T>
    
    Returns:
    
    a new ConfigurationMerger instance
    
    Throws:
    
    UnsupportedOperationException - if no original helper is specified for this NullConfigurationHelper.

Class NullConfigurationHelper<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.obvj.confectory.internal.helper.ConfigurationHelper

Constructor Detail

NullConfigurationHelper

NullConfigurationHelper

Method Detail

getBean

get

getBoolean

getInteger

getLong

getDouble

getString

getMandatoryBoolean

getMandatoryInteger

getMandatoryLong

getMandatoryDouble

getMandatoryString

configurationMerger