net.obvj.confectory.mapper

Class INIToObjectMapper<T>

java.lang.Object

net.obvj.confectory.mapper.AbstractINIMapper<T>

net.obvj.confectory.mapper.INIToObjectMapper<T>

Type Parameters:

T - the target type to be produced by this Mapper

All Implemented Interfaces:

Mapper<T>

public class INIToObjectMapper<T>
extends AbstractINIMapper<T>
implements Mapper<T>

A specialized Mapper that loads the contents of a valid INI Source (e.g.: file, URL) into a POJO (Plain-Old Java Object).

Every property and section will be assigned to a field in the target object in either of the following cases:

• the field is marked with the @Property annotation, defining a custom key to be mapped; or
• the field name is equal to the property key (with no need to use an annotation in these cases)

Notes:

• The fields in the target object can be private (recommended)
• Fields marked transient are ignored
• If the associated property is missing in the source, the corresponding field will assume a default value, i.e.: null for object types, zero for numeric types, and false for booleans.
• If the a section is not mapped to dedicated object in the target class, the whole section will be skipped

Since:

2.0.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor and Description
INIToObjectMapper(Class<T> targetType) Builds a new INIToObjectMapper with the specified target type.

Method Summary

Modifier and Type	Method and Description
T	apply(InputStream inputStream) Applies this Mapper into the given input.
ConfigurationHelper<T>	configurationHelper(T object) 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

INIToObjectMapper

public INIToObjectMapper(Class<T> targetType)

Builds a new INIToObjectMapper with the specified target type.

Parameters:

targetType - the target type to be produced by this Mapper

Method Detail

apply

public T 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<T>

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<T> configurationHelper(T object)

Description copied from interface: Mapper

Creates a new ConfigurationHelper instance recommended by this Mapper.

Specified by:

configurationHelper in interface Mapper<T>

Parameters:

object - the configuration object to be used by the helper

Returns:

a new ConfigurationHelper instance