SnakeYAML Engine KMP/it.krzeminski.snakeyaml.engine.kmp.api/DumpSettings

DumpSettings

class DumpSettings(val isExplicitStart: Boolean = false, val isExplicitEnd: Boolean = false, val explicitRootTag: Tag? = null, val anchorGenerator: AnchorGenerator = NumberAnchorGenerator(), val yamlDirective: SpecVersion? = null, val tagDirective: Map<String, String> = emptyMap(), val defaultFlowStyle: FlowStyle = FlowStyle.AUTO, val defaultScalarStyle: ScalarStyle = ScalarStyle.PLAIN, val nonPrintableStyle: NonPrintableStyle = NonPrintableStyle.ESCAPE, val schema: Schema = DEFAULT_SCHEMA, val isCanonical: Boolean = false, val isMultiLineFlow: Boolean = false, val isUseUnicodeEncoding: Boolean = true, val indent: Int = 2, val indicatorIndent: Int = 0, val width: Int = 80, val bestLineBreak: String = "", val isSplitLines: Boolean = true, val maxSimpleKeyLength: Int = 128, val customProperties: Map<SettingKey, Any> = emptyMap(), val indentWithIndicator: Boolean = false, val dumpComments: Boolean = false, val isDereferenceAliases: Boolean = false)(source)

Immutable configuration for serialization.

Constructors

DumpSettings

constructor(isExplicitStart: Boolean = false, isExplicitEnd: Boolean = false, explicitRootTag: Tag? = null, anchorGenerator: AnchorGenerator = NumberAnchorGenerator(), yamlDirective: SpecVersion? = null, tagDirective: Map<String, String> = emptyMap(), defaultFlowStyle: FlowStyle = FlowStyle.AUTO, defaultScalarStyle: ScalarStyle = ScalarStyle.PLAIN, nonPrintableStyle: NonPrintableStyle = NonPrintableStyle.ESCAPE, schema: Schema = DEFAULT_SCHEMA, isCanonical: Boolean = false, isMultiLineFlow: Boolean = false, isUseUnicodeEncoding: Boolean = true, indent: Int = 2, indicatorIndent: Int = 0, width: Int = 80, bestLineBreak: String = "", isSplitLines: Boolean = true, maxSimpleKeyLength: Int = 128, customProperties: Map<SettingKey, Any> = emptyMap(), indentWithIndicator: Boolean = false, dumpComments: Boolean = false, isDereferenceAliases: Boolean = false)

Properties

anchorGenerator

val anchorGenerator: AnchorGenerator

Define anchor name generator (by default 'id' + number)

bestLineBreak

val bestLineBreak: String

If the YAML is created for another platform (for instance, on Windows to be consumed under Linux) than this setting is used to define the line ending. The platform line end is used by default.

customProperties

val customProperties: Map<SettingKey, Any>

Custom property is the way to give some runtime parameters to be used during dumping

defaultFlowStyle

val defaultFlowStyle: FlowStyle

Define flow style

defaultScalarStyle

val defaultScalarStyle: ScalarStyle

Define default scalar style

dumpComments

val dumpComments: Boolean = false

Set to true to add comments from Nodes to the output.

explicitRootTag

val explicitRootTag: Tag? = null

Define root Tag or let the tag be detected automatically.

indent

val indent: Int = 2

Define the amount of spaces for the indent in the block flow style. Default is 2.

indentWithIndicator

val indentWithIndicator: Boolean = false

Set to true to add the indent for sequences to the general indent

indicatorIndent

val indicatorIndent: Int = 0

Adds the specified indent for sequence indicator in the block flow. Default is 0.

isCanonical

val isCanonical: Boolean = false

Enforce canonical representation

isDereferenceAliases

val isDereferenceAliases: Boolean = false

Disable usage of anchors and aliases while serialising an instance. Recursive objects will not work when they are disabled. (Forces Serializer to skip emitting anchors names, emit Node content instead of Alias, fail with SerializationException if serialized structure is recursive.)

isExplicitEnd

val isExplicitEnd: Boolean = false

Add '...' at the end of the document.

isExplicitStart

val isExplicitStart: Boolean = false

Add '---' at the beginning of the document.

isMultiLineFlow

val isMultiLineFlow: Boolean = false

Use pretty flow style when every value in the flow context gets a separate line.

isSplitLines

val isSplitLines: Boolean = true

Define whether to split long lines

isUseUnicodeEncoding

val isUseUnicodeEncoding: Boolean = true

Specify whether to emit non-ASCII printable Unicode characters (emit Unicode char or escape sequence starting with '\\u'). The default value is true. When set to false, printable non-ASCII characters (Cyrillic, Chinese, etc.) will be not printed but escaped (to support ASCII terminals).

maxSimpleKeyLength

val maxSimpleKeyLength: Int = 128

Define max key length to use simple key (without ?). More info

nonPrintableStyle

val nonPrintableStyle: NonPrintableStyle

When a String object contains non-printable characters, they are escaped with \\u or \\x notation. Sometimes it is better to transform this data to binary (with the !!binary tag). String objects with printable data are not affected by this setting. Set this to BINARY to force non-printable String to represented as binary (byte array).

schema

val schema: Schema

Provide either recommended or custom schema instead of default it.krzeminski.snakeyaml.engine.kmp.schema.DEFAULT_SCHEMA. These 3 are available it.krzeminski.snakeyaml.engine.kmp.schema.FailsafeSchema, it.krzeminski.snakeyaml.engine.kmp.schema.JsonSchema, it.krzeminski.snakeyaml.engine.kmp.schema.CoreSchema.

tagDirective

val tagDirective: Map<String, String>

Add TAG directive

width

val width: Int = 80

Set max width for literal scalars. When the scalar representation takes more then the preferred with the scalar will be split into a few lines. The default is 80.

yamlDirective

val yamlDirective: SpecVersion? = null

Add YAML directive