net.obvj.confectory.mapper

Class JacksonYAMLToObjectMapper<T>

java.lang.Object

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

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

Type Parameters:

T - the target type to be produced by this Mapper (the target class may contain Jackson annotations for due mapping -- e.g.: @JsonProperty, @JsonIgnore)

All Implemented Interfaces:

Mapper<T>

Direct Known Subclasses:

JacksonYAMLToJsonNodeMapper

public class JacksonYAMLToObjectMapper<T>
extends JacksonJsonToObjectMapper<T>
implements Mapper<T>

A specialized Mapper that loads the contents of a valid YAML Source (e.g.: file, URL, string) into POJO (Plain Old Java Object), using Jackson's YAMLMapper.

Additional details may be found at Jackson's official documentation.

Since version 2.4.0, this class supports lookup and registration of Jackson modules by default. However, since modules lookup is considered a potentially expensive operation, it can be disabled by setting the disableModules flag in the constructor:

new JacksonYAMLToObjectMapper(Class<?>, boolean)

Note: To avoid a performance overhead, Jackson modules lookup happens automatically at the first instantiation of a JacksonJsonToObjectMapper with enable support for modules.

Since:

0.3.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor and Description
JacksonYAMLToObjectMapper(Class<T> targetType) Builds a new YAML mapper with the specified target type and support for Jackson modules enabled by default.
JacksonYAMLToObjectMapper(Class<T> targetType, boolean disableModules) Builds a new YAML mapper with the specified target type.

Method Summary

Modifier and Type	Method and Description
T	apply(InputStream inputStream)

Methods inherited from class net.obvj.confectory.mapper.JacksonJsonToObjectMapper

configurationHelper, reloadModulesCache, resetModulesCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.obvj.confectory.mapper.Mapper

configurationHelper

Constructor Detail

JacksonYAMLToObjectMapper

public JacksonYAMLToObjectMapper(Class<T> targetType)

Builds a new YAML mapper with the specified target type and support for Jackson modules enabled by default.

Parameters:

targetType - the target type to be produced by this Mapper

JacksonYAMLToObjectMapper

public JacksonYAMLToObjectMapper(Class<T> targetType,
                                 boolean disableModules)

Builds a new YAML mapper with the specified target type.

Parameters:

targetType - the target type to be produced by this Mapper

disableModules - disable Jackson modules; useful for an optimized processing if Jackson add-ons are NOT required

Since:

2.4.0

Method Detail

apply

public T apply(InputStream inputStream)
        throws IOException

Specified by:

apply in interface Mapper<T>

Overrides:

apply in class JacksonJsonToObjectMapper<T>

Throws:

IOException