ConfigurationHelper (Confectory Core 2.5.0 API)

Type Parameters:

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

All Superinterfaces:

ConfigurationDataRetriever<T>

All Known Implementing Classes:

BasicConfigurationHelper, BeanConfigurationHelper, DocumentConfigurationHelper, GenericJsonConfigurationHelper, JsonSmartConfigurationHelper, NullConfigurationHelper, PropertiesConfigurationHelper
```
public interface ConfigurationHelper<T>
extends ConfigurationDataRetriever<T>
```
An abstraction for objects that retrieve data from previously loaded Configuration objects.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ConfigurationMerger<T>`	`configurationMerger()`	Creates the applicable `ConfigurationMerger` object for the type associated with this `ConfigurationHelper`.
`static <T> ConfigurationHelper<T>`	`newInstance(T bean, Mapper<T> mapper)`	Creates a new `ConfigurationHelper` for the given `Mapper`.

Methods inherited from interface net.obvj.confectory.ConfigurationDataRetriever
get, getAsString, getBean, getBoolean, getDouble, getInteger, getLong, getMandatoryBoolean, getMandatoryDouble, getMandatoryInteger, getMandatoryLong, getMandatoryString, getString

- Method Detail
  - newInstance
```
static <T> ConfigurationHelper<T> newInstance(T bean,
                                              Mapper<T> mapper)
```
    Creates a new ConfigurationHelper for the given Mapper.
    If the specified bean is null, a NullConfigurationHelper will be instantiated.
    
    Type Parameters:
    
    T - the bean type which configuration data is to be retrieved
    
    Parameters:
    
    bean - the bean to be evaluated; may be null
    
    mapper - the Mapper whose helper should be instantiated; not null
    
    Returns:
    
    a new ConfigurationHelper instance for the specified Mapper
    
    Throws:
    
    NullPointerException - if the specified mapper is null
    
    Since:
    
    2.2.0
  - configurationMerger
```
ConfigurationMerger<T> configurationMerger()
```
    Creates the applicable ConfigurationMerger object for the type associated with this ConfigurationHelper.
    
    Returns:
    
    a new ConfigurationMerger instance
    
    Since:
    
    2.2.0