Package net.obvj.confectory.mapper

Class PropertiesMapper

java.lang.Object

net.obvj.confectory.mapper.PropertiesMapper

All Implemented Interfaces:

Mapper<Properties>

public class PropertiesMapper
extends Object
implements Mapper<Properties>

A specialized Mapper that loads the contents of a Source (e.g.: file, URL) as Properties (a table of key-value pairs).

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor	Description
PropertiesMapper()

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesMapper

public PropertiesMapper()

Method Detail

apply

public Properties apply(InputStream inputStream)
                 throws IOException

Description copied from interface: Mapper

Applies this Mapper into the given input.

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

Specified by:

apply in interface Mapper<Properties>

Parameters:

inputStream - 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

public ConfigurationHelper<Properties> configurationHelper(Properties properties)

Description copied from interface: Mapper

Creates a new ConfigurationHelper instance recommended by this Mapper.

Specified by:

configurationHelper in interface Mapper<Properties>

Parameters:

properties - the configuration object to be used by the helper

Returns:

a new ConfigurationHelper instance