edu.byu.hbll.config

Class YamlLoader

java.lang.Object

edu.byu.hbll.config.YamlLoader

public class YamlLoader
extends Object

Loads YAML data into JsonNodes and/or target POJOs.

This loader uses Jackson's YAML plugin to do the actual parsing of data. As such, this class follows Jackson's own recommendations regarding thread-safeness; that is that instances of this class are fully thread-safe provided that ALL configuration of the internal ObjectMapper occurs before any loading/deserialization takes place.

YAML documents containing an \@import field as an array of file paths will recursively import the YAML documents found at those paths giving precedence to the YAML document doing the import.

Constructor Summary

Constructors

Constructor and Description
YamlLoader()

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Returns the ObjectMapper used to load/deserialize YAML files.
<T> T	load(Class<T> targetType, Path... paths) Deserializes the YAML data contained in the provided files into the provided Jackson POJO.
<T> T	load(Class<T> targetType, Reader... readers) Deserializes the YAML data contained in the provided readers into the provided Jackson POJO.
com.fasterxml.jackson.databind.JsonNode	load(Path... paths) Deserializes the YAML data contained in the provided files into a single JsonNode.
com.fasterxml.jackson.databind.JsonNode	load(Reader... readers) Deserializes the YAML data contained in the provided readers into a single JsonNode.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlLoader

public YamlLoader()

Method Detail

load

public com.fasterxml.jackson.databind.JsonNode load(Reader... readers)
                                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                                    IOException

Deserializes the YAML data contained in the provided readers into a single JsonNode. If more than one reader is provided, then the first reader will be used to established a baseline node; subsequent readers will merge into that baseline node in sequence, adding or overwriting fields as appropriate in a cascading fashion.

Parameters:

readers - the readers containing the raw YAML data

Returns:

the merged JsonNode

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if a failure occurs while parsing the JSON data

IOException - if one or more of the readers fails

load

public <T> T load(Class<T> targetType,
                  Reader... readers)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  IOException

Deserializes the YAML data contained in the provided readers into the provided Jackson POJO. If more than one reader is provided, then the first reader will be used to established a baseline JsonNode; subsequent readers will merge into that baseline node in sequence, adding or overwriting fields as appropriate in a cascading fashion before the final boxing of the data into the target POJO type.

Parameters:

readers - the readers containing the raw YAML data

Returns:

the target object containing the parsed data

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if a failure occurs while parsing the JSON data or while boxing the result

IOException - if one or more of the readers fails

load

public com.fasterxml.jackson.databind.JsonNode load(Path... paths)
                                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                                    IOException

Deserializes the YAML data contained in the provided files into a single JsonNode. If more than one file is provided, then the first file will be used to established a baseline node; subsequent files will merge into that baseline node in sequence, adding or overwriting fields as appropriate in a cascading fashion.

Parameters:

paths - the files containing the raw YAML data

Returns:

the merged JsonNode

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if a failure occurs while parsing the JSON data

IOException - if a failure occurs while reading data from one or more of the files

load

public <T> T load(Class<T> targetType,
                  Path... paths)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  IOException

Deserializes the YAML data contained in the provided files into the provided Jackson POJO. If more than one file is provided, then the first file will be used to established a baseline JsonNode; subsequent files will merge into that baseline node in sequence, adding or overwriting fields as appropriate in a cascading fashion before the final boxing of the data into the target POJO type.

Parameters:

paths - the files containing the raw YAML data

Returns:

the target object containing the parsed data

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if a failure occurs while parsing the JSON data or while boxing the result

IOException - if a failure occurs while reading data from one or more of the files

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns the ObjectMapper used to load/deserialize YAML files. Clients may modify this ObjectMapper to meet their specific needs.

Returns:

the objectMapper