serialization/nl.adaptivity.xmlutil.serialization/XmlConfig/Builder

Builder

class Builder(source)

Configuration for the xml parser.

Constructors

Builder

constructor(config: XmlConfig)

Properties

autoPolymorphic

var autoPolymorphic: Boolean?

Should polymorphic information be retrieved using SerializersModule configuration. This replaces XmlPolyChildren, but changes serialization where that annotation is not applied. This option will become the default in the future although XmlPolyChildren will retain precedence (when present).

defaultToGenericParser

var defaultToGenericParser: Boolean

Default parsing to the optimized generic parser rather than using the platform specific one

indent

var indent: Int

The indentation level (in spaces) to use. This is derived from indentString. Tabs are counted as 8 characters, everything else as 1. When setting it will update indentString with indent space characters

indentString

var indentString: String

The indentation to use. This is passed to the XmlWriter. Note that at this point no validation of the indentation is done, if it is not valid whitespace it will produce unexpected XML.

isAlwaysDecodeXsiNil

var isAlwaysDecodeXsiNil: Boolean

isCachingEnabled

var isCachingEnabled: Boolean

isCollectingNSAttributes

var isCollectingNSAttributes: Boolean

This property determines whether the serialization will collect all used namespaces and emits all namespace attributes on the root tag.

isInlineCollapsed

var isInlineCollapsed: Boolean

Determines whether inline classes are merged with their content. Note that inline classes may still determine the tag name used for the data even if the actual contents come from the child content. The actual name used is ultimately determined by the policy in use.

isUnchecked

var isUnchecked: Boolean

This property can be used to disable various checks on the correctness of the serializer descriptions. This should speed up processing, but may give surprising results in the presence of an error.

nilAttribute

var nilAttribute: Pair<QName, String>?

policy

var policy: XmlSerializationPolicy?

repairNamespaces

var repairNamespaces: Boolean

Should namespaces automatically be repaired. This option will be passed on to the XmlWriter

xmlDeclMode

var xmlDeclMode: XmlDeclMode

xmlVersion

var xmlVersion: XmlVersion

Functions

defaultPolicy

inline fun defaultPolicy(configure: DefaultXmlSerializationPolicy.Builder.() -> Unit)

fast

fun fast()

Configure the parser using the latest recommended settings for fast (en/de)coding. Note that this function has no guarantee of stability.

inline fun fast(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)

Configure the policy and the config builder with the latest recommended settings and policy. Note that this function has no guarantee of stability.

fast_0_90_2

fun fast_0_90_2()

Configure the format using the recommended configuration as of version 0.87.0. This configuration is stable.

inline fun fast_0_90_2(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)

Configure the format starting with the recommended configuration as of version 0.87.0. This configuration is stable. Note that this defaults to xml 1.1 with (minimal) document type declaration. A document type declaration is required for XML 1.1 (otherwise it reverts to 1.0).

recommended

fun recommended()

Configure the parser using the latest recommended settings. Note that this function has no guarantee of stability.

inline fun recommended(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)

Configure the policy and the config builder with the latest recommended settings and policy. Note that this function has no guarantee of stability.

recommended_0_86_3

fun recommended_0_86_3()

Configure the format using the recommended configuration as of version 0.86.3. This configuration is stable.

inline fun recommended_0_86_3(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)

Configure the format starting with the recommended configuration as of version 0.86.3. This configuration is stable.

recommended_0_87_0

fun recommended_0_87_0()

Configure the format using the recommended configuration as of version 0.87.0. This configuration is stable.

inline fun recommended_0_87_0(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)

Configure the format starting with the recommended configuration as of version 0.87.0. This configuration is stable.

recommended_0_90_2

fun recommended_0_90_2()

Configure the format using the recommended configuration as of version 0.87.0. This configuration is stable.

inline fun recommended_0_90_2(configurePolicy: DefaultXmlSerializationPolicy.Builder.() -> Unit)