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

LoadSettingsBuilder

class LoadSettingsBuilder

Builder pattern implementation for LoadSettings

Functions

build

fun build(): LoadSettings

Build immutable LoadSettings

setAllowDuplicateKeys

fun setAllowDuplicateKeys(allowDuplicateKeys: Boolean): LoadSettingsBuilder

YAML 1.2 does require unique keys. To support the backwards compatibility it is possible to select what should happend when non-unique keys are detected.

setAllowRecursiveKeys

fun setAllowRecursiveKeys(allowRecursiveKeys: Boolean): LoadSettingsBuilder

Allow only non-recursive keys for maps and sets. By default, is it not allowed. Even though YAML allows to use anything as a key, it may cause unexpected issues when loading recursive structures.

setBufferSize

fun setBufferSize(bufferSize: Int): LoadSettingsBuilder

Buffer size for incoming data stream. If the incoming stream is already buffered, then changing the buffer does not improve the performance

setCodePointLimit

fun setCodePointLimit(codePointLimit: Int): LoadSettingsBuilder

The max amount of code points for every input YAML document in the stream. Please be aware that byte limit depends on the encoding.

setCustomProperty

fun setCustomProperty(key: SettingKey, value: Any): LoadSettingsBuilder

Provide a custom property to be used later

setDefaultList

fun setDefaultList(defaultList: LoadSettings.CollectionProvider<MutableList<Any?>>): LoadSettingsBuilder

Provide default List implementation. ArrayList is used if nothing provided.

setDefaultMap

fun setDefaultMap(defaultMap: LoadSettings.CollectionProvider<MutableMap<Any?, Any?>>): LoadSettingsBuilder

Provide default Map implementation. LinkedHashMap is used if nothing provided.

setDefaultSet

fun setDefaultSet(defaultSet: LoadSettings.CollectionProvider<MutableSet<Any?>>): LoadSettingsBuilder

Provide default Set implementation. LinkedHashSet is used if nothing provided.

setEnvConfig

fun setEnvConfig(envConfig: EnvConfig?): LoadSettingsBuilder

Define EnvConfig to parse EVN format. If not set explicitly the variable substitution is not applied

setLabel

fun setLabel(label: String): LoadSettingsBuilder

Label for the input data. Can be used to improve the error message.

setMaxAliasesForCollections

fun setMaxAliasesForCollections(maxAliasesForCollections: Int): LoadSettingsBuilder

Restrict the number of aliases for collection nodes to prevent 'billion laughs attack'. The purpose of this setting is to force SnakeYAML to fail before a lot of CPU and memory resources are allocated for the parser. Aliases for scalar nodes do not count because they do not grow exponentially.

setParseComments

fun setParseComments(parseComments: Boolean): LoadSettingsBuilder

Parse comments to the presentation tree (Node). False by default

setSchema

fun setSchema(schema: Schema): LoadSettingsBuilder

Provide either recommended or custom schema instead of default * org.snakeyaml.engine.v2.schema.CoreSchema These 3 are available org.snakeyaml.engine.v2.schema.FailsafeSchema, org.snakeyaml.engine.v2.schema.JsonSchema, org.snakeyaml.engine.v2.schema.CoreSchema.

setTagConstructors

fun setTagConstructors(tagConstructors: Map<Tag, ConstructNode>): LoadSettingsBuilder

Provide constructors for the specified tags.

setUseMarks

fun setUseMarks(useMarks: Boolean): LoadSettingsBuilder

Marks are only used for error messages, but they require a lot of memory. true by default.

setVersionFunction

fun setVersionFunction(versionFunction: LoadSettings.SpecVersionMutator): LoadSettingsBuilder

Manage YAML directive value which defines the version of the YAML specification. This parser supports YAML 1.2, but it can parse most of YAML 1.1 and YAML 1.0