YamlUtils

Utilities to convert from and to YAML format.

API

YamlUtils.java
class YamlUtils {
  Try<T> tryRead(Class<T> mappedType, String stringUtf8, JsonUtils.JacksonCustomizer... customizers)     (1)
  Try<T> tryRead(Class<T> mappedType, DataSource source, JsonUtils.JacksonCustomizer... customizers)     (2)
  Try<List<T>> tryReadAsList(Class<T> elementType, DataSource source, JsonUtils.JacksonCustomizer... customizers)     (3)
  Try<T> tryReadCustomized(Class<T> mappedType, String stringUtf8, YamlLoadCustomizer loadCustomizer, JsonUtils.JacksonCustomizer... customizers)     (4)
  Try<T> tryReadCustomized(Class<T> mappedType, DataSource source, YamlLoadCustomizer loadCustomizer, JsonUtils.JacksonCustomizer... customizers)     (5)
  Try<List<T>> tryReadAsListCustomized(Class<T> elementType, DataSource source, YamlLoadCustomizer loadCustomizer, JsonUtils.JacksonCustomizer... customizers)     (6)
  Try<Stream<String>> tryReadMultiDoc(DataSource source)     (7)
  void write(Object pojo, DataSink sink, JsonUtils.JacksonCustomizer... customizers)     (8)
  String toStringUtf8(Object pojo, JsonUtils.JacksonCustomizer... customizers)     (9)
  void writeCustomized(Object pojo, DataSink sink, YamlDumpCustomizer dumpCustomizer, JsonUtils.JacksonCustomizer... customizers)     (10)
  String toStringUtf8Customized(Object pojo, YamlDumpCustomizer dumpCustomizer, JsonUtils.JacksonCustomizer... customizers)     (11)
  String writeMultiDoc(Iterable<String> yamlDocuments)     (12)
  String writeMultiDoc(Stream<String> yamlDocumentStream)     (13)
  DumperOptions allowReadOnlyProperties(DumperOptions opts)     (14)
}
1 tryRead(Class, String, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given UTF8 encoded String into an instance of given mappedType .
2 tryRead(Class, DataSource, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into an instance of given requiredType .
3 tryReadAsList(Class, DataSource, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into a List with given elementType .
4 tryReadCustomized(Class, String, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given UTF8 encoded String into an instance of given mappedType .
5 tryReadCustomized(Class, DataSource, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into an instance of given requiredType .
6 tryReadAsListCustomized(Class, DataSource, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into a List with given elementType .
7 tryReadMultiDoc(DataSource)

Returns a Stream of (arbitrary) YAML Document junks from provided DataSource , where each junk typically needs further parsing individually.
8 write(Object, DataSink, JsonUtils_JacksonCustomizer)

Writes given pojo to given DataSink .
9 toStringUtf8(Object, JsonUtils_JacksonCustomizer)

Converts given pojo to an UTF8 encoded String .
10 writeCustomized(Object, DataSink, YamlDumpCustomizer, JsonUtils_JacksonCustomizer)

Writes given pojo to given DataSink .
11 toStringUtf8Customized(Object, YamlDumpCustomizer, JsonUtils_JacksonCustomizer)

Converts given pojo to an UTF8 encoded String .
12 writeMultiDoc(Iterable)

Concatenates given Iterable into a multi-doc YAML.
13 writeMultiDoc(Stream)

Concatenates given Stream into a multi-doc YAML.
14 allowReadOnlyProperties(DumperOptions)

Include read-only JavaBean properties (the ones without setters) in the YAML document.

Members

tryRead(Class, String, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given UTF8 encoded String into an instance of given mappedType .

tryRead(Class, DataSource, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into an instance of given requiredType .

tryReadAsList(Class, DataSource, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into a List with given elementType .

Either parses (regular) YAML-list format or multi-doc YAML format.

tryReadCustomized(Class, String, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given UTF8 encoded String into an instance of given mappedType .

tryReadCustomized(Class, DataSource, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into an instance of given requiredType .

tryReadAsListCustomized(Class, DataSource, YamlLoadCustomizer, JsonUtils_JacksonCustomizer)

Tries to deserialize YAML content from given DataSource into a List with given elementType .

Either parses (regular) YAML-list format or multi-doc YAML format.

tryReadMultiDoc(DataSource)

Returns a Stream of (arbitrary) YAML Document junks from provided DataSource , where each junk typically needs further parsing individually.

write(Object, DataSink, JsonUtils_JacksonCustomizer)

Writes given pojo to given DataSink .

toStringUtf8(Object, JsonUtils_JacksonCustomizer)

Converts given pojo to an UTF8 encoded String .

writeCustomized(Object, DataSink, YamlDumpCustomizer, JsonUtils_JacksonCustomizer)

Writes given pojo to given DataSink .

toStringUtf8Customized(Object, YamlDumpCustomizer, JsonUtils_JacksonCustomizer)

Converts given pojo to an UTF8 encoded String .

writeMultiDoc(Iterable)

Concatenates given Iterable into a multi-doc YAML.

writeMultiDoc(Stream)

Concatenates given Stream into a multi-doc YAML.

allowReadOnlyProperties(DumperOptions)

Include read-only JavaBean properties (the ones without setters) in the YAML document.

By default these properties are not included to be able to parse later the same JavaBean.