Package dev.enola.common.io.object.template

Class TemplatedObjectReader

java.lang.Object

dev.enola.common.io.object.template.TemplatedObjectReader

All Implemented Interfaces:

ObjectReader

public class TemplatedObjectReader
extends Object
implements ObjectReader

An ObjectReader that first processes a resource as a template.

It reads a resource, parses it as a Map to be used as a model, then treats the original resource content as a template, applies the model to it, and finally delegates parsing of the resulting content to another ObjectReader.

This allows for self-referential templates, where values defined in a file (e.g. YAML) can be used in other parts of the same file.

NOTE: This implementation reads the entire resource into memory to perform templating. It is not suitable for very large resources.

Constructor Summary

Constructors

Constructor	Description
TemplatedObjectReader(ObjectReader delegate)

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	optional(ReadableResource resource, Class<T> type)	Read an object of Class T from the resource, if present.
<T> Iterable<T>	readArray(ReadableResource resource, Class<T> type)	Read e.g.
<T> Iterable<T>	readStream(ReadableResource resource, Class<T> type)	Read e.g.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.enola.common.io.object.ObjectReader

read

Constructor Details

TemplatedObjectReader

public TemplatedObjectReader(ObjectReader delegate)

Method Details

optional

public <T> Optional<T> optional(ReadableResource resource,
 Class<T> type)
                         throws IOException

Description copied from interface: ObjectReader

Read an object of Class T from the resource, if present.

Specified by:

optional in interface ObjectReader

Throws:

IOException

readArray

public <T> Iterable<T> readArray(ReadableResource resource,
 Class<T> type)
                          throws IOException

Description copied from interface: ObjectReader

Read e.g. a JSON (or YAML) [ ... ] array.

Specified by:

readArray in interface ObjectReader

Throws:

IOException

readStream

public <T> Iterable<T> readStream(ReadableResource resource,
 Class<T> type)
                           throws IOException

Description copied from interface: ObjectReader

Read e.g. a YAML stream. (For formats such as plain JSON which do not directly support a streams syntax, this will always return a single element.)

Specified by:

readStream in interface ObjectReader

Throws:

IOException