net.obvj.confectory.mapper

Interface Mapper<T>

Type Parameters:

T - the configuration output type

All Known Implementing Classes:

AbstractBeanMapper, AbstractINIMapper, DummyMapper, INIToJSONObjectMapper, INIToObjectMapper, JSONObjectMapper, PropertiesMapper, PropertiesToObjectMapper, StringMapper

public interface Mapper<T>

The base interface for a configuration mapper.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type	Method and Description
T	apply(InputStream input) Applies this Mapper into the given input.
ConfigurationHelper<T>	configurationHelper(T bean) Creates a new ConfigurationHelper instance recommended by this Mapper.

Method Detail

apply

T apply(InputStream input)
 throws IOException

Applies this Mapper into the given input.

Note: The input stream must be closed by the caller after the mapping operation.

Parameters:

input - the input stream to be mapped

Returns:

the mapped object

Throws:

IOException - if a low-level I/O problem (such and unexpected end-of-input, or network error) occurs

configurationHelper

ConfigurationHelper<T> configurationHelper(T bean)

Creates a new ConfigurationHelper instance recommended by this Mapper.

Parameters:

bean - the configuration object to be used by the helper

Returns:

a new ConfigurationHelper instance