SnakeYAML Engine KMP/org.snakeyaml.engine.v2.api/Load

Load

class Load @JvmOverloads constructor(settings: LoadSettings, constructor: BaseConstructor = StandardConstructor(settings))

Common way to load Java instance(s). This class is not thread-safe. Which means that all the methods of the same instance can be called only by one thread. It is better to create an instance for every YAML stream. The instance is stateful. Only one of the 'load' methods may be called, and it may be called only once.

Parameters

settings

configuration

constructor

custom YAML constructor

Constructors

Load

@JvmOverloads

constructor(settings: LoadSettings, constructor: BaseConstructor = StandardConstructor(settings))

Functions

loadAllFromInputStream

fun loadAllFromInputStream(yamlStream: InputStream): Iterable<Any?>

Parse all YAML documents in a stream and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.

loadAllFromReader

fun loadAllFromReader(yamlReader: Reader): Iterable<Any?>

Parse all YAML documents in a String and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.

loadAllFromString

fun loadAllFromString(yaml: String): Iterable<Any?>

Parse all YAML documents in a String and produce corresponding Java objects. (Because the encoding in known BOM is not respected.) The documents are parsed only when the iterator is invoked.

loadFromInputStream

fun loadFromInputStream(yamlStream: InputStream): Any?

Parse the only YAML document in a stream and produce the corresponding Java object.

loadFromReader

fun loadFromReader(yamlReader: Reader): Any?

Parse a YAML document and create a Java instance

loadFromString

fun loadFromString(yaml: String): Any?

Parse a YAML document and create a Java instance