com.sabre.oss.conf4j.json.source

Class AbstractJacksonConfigurationSource

java.lang.Object

com.sabre.oss.conf4j.json.source.AbstractJacksonConfigurationSource

All Implemented Interfaces:

ConfigurationSource, IterableConfigurationSource

Direct Known Subclasses:

JsonConfigurationSource

public abstract class AbstractJacksonConfigurationSource
extends Object
implements IterableConfigurationSource

Configuration source which which uses Jackson for converting source file to map. Subclasses can provide support for formats supported by Jackson, for example JSON or YAML.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper, File file) Constructs value source from File.
protected	AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper, InputStream inputStream) Constructs value source from InputStream.
protected	AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper, Reader reader) Constructs value source from Reader.

Method Summary

Modifier and Type	Method and Description
Iterable<ConfigurationEntry>	getAllConfigurationEntries()
OptionalValue<String>	getValue(String key, Map<String,String> attributes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sabre.oss.conf4j.source.ConfigurationSource

findEntry

Constructor Detail

AbstractJacksonConfigurationSource

protected AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                             InputStream inputStream)

Constructs value source from InputStream.

Note: File content is loaded and processed in the constructor and inputStream is closed at the end of processing.

Parameters:

objectMapper - configured object mapper.

inputStream - input stream which provides JSON.

Throws:

UncheckedIOException - when IOException is thrown during processing.

AbstractJacksonConfigurationSource

protected AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                             Reader reader)

Constructs value source from Reader.

Note: File content is loaded and processed in the constructor and reader is closed at the end of processing.

Parameters:

objectMapper - configured object mapper.

reader - reader which provides JSON source.

Throws:

UncheckedIOException - when IOException is thrown during processing.

AbstractJacksonConfigurationSource

protected AbstractJacksonConfigurationSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                             File file)

Constructs value source from File.

Parameters:

objectMapper - configured object mapper.

file - file which contains JSON source.

Throws:

IllegalArgumentException - when provided file not found.

UncheckedIOException - when IOException is thrown during processing.

Method Detail

getValue

public OptionalValue<String> getValue(String key,
                                      Map<String,String> attributes)

Specified by:

getValue in interface ConfigurationSource

getAllConfigurationEntries

public Iterable<ConfigurationEntry> getAllConfigurationEntries()

Specified by:

getAllConfigurationEntries in interface IterableConfigurationSource