YamlObjectReaderWriter

java.lang.Object

dev.enola.common.io.object.jackson.YamlObjectReaderWriter

All Implemented Interfaces:: ObjectReader, ObjectReaderWriter, ObjectWriter

public class YamlObjectReaderWriter extends Object

Constructor Summary

Constructors

Constructor

Description

YamlObjectReaderWriter()

YamlObjectReaderWriter(ProviderFromID provider)
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.

boolean

write(Object instance, WritableResource resource)

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

Methods inherited from interface dev.enola.common.io.object.ObjectWriter
write

Constructor Details
- YamlObjectReaderWriter
  
  public YamlObjectReaderWriter()
- YamlObjectReaderWriter
  
  public YamlObjectReaderWriter(ProviderFromID provider)
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
- write
  
  @CanIgnoreReturnValue public boolean write(Object instance, WritableResource resource) throws IOException
  
  Specified by:
  
  write in interface ObjectWriter
  
  Throws:
  
  IOException