serialization/nl.adaptivity.xmlutil.serialization/XmlSerializationPolicy

XmlSerializationPolicy

interface XmlSerializationPolicy(source)

Inheritors

DefaultXmlSerializationPolicy

Types

ActualNameInfo

data class ActualNameInfo(val serialName: String, val annotatedName: QName)

Companion

object Companion

DeclaredNameInfo

data class DeclaredNameInfo(val serialName: String, val annotatedName: QName?, val isDefaultNamespace: Boolean)

XmlEncodeDefault

enum XmlEncodeDefault : Enum<XmlSerializationPolicy.XmlEncodeDefault>

Properties

defaultObjectOutputKind

open val defaultObjectOutputKind: OutputKind

defaultPrimitiveOutputKind

open val defaultPrimitiveOutputKind: OutputKind

isStrictAttributeNames

open val isStrictAttributeNames: Boolean

isStrictBoolean

open val isStrictBoolean: Boolean

isStrictOtherAttributes

open val isStrictOtherAttributes: Boolean

verifyElementOrder

open val verifyElementOrder: Boolean

Functions

attributeListDelimiters

open fun attributeListDelimiters(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): Array<String>

Determine the delimiters to use to separate attributes. When writing will always write the first element.

defaultOutputKind

open fun defaultOutputKind(serialKind: SerialKind): OutputKind

effectiveName

abstract fun effectiveName(serializerParent: SafeParentInfo, tagParent: SafeParentInfo, outputKind: OutputKind, useName: XmlSerializationPolicy.DeclaredNameInfo = tagParent.elementUseNameInfo): QName

effectiveOutputKind

open fun effectiveOutputKind(serializerParent: SafeParentInfo, tagParent: SafeParentInfo, canBeAttribute: Boolean): OutputKind

elementNamespaceDecls

open fun elementNamespaceDecls(serializerParent: SafeParentInfo): List<Namespace>

Determine namespace prefixes to make sure are set upon the tag.

enumEncoding

open fun enumEncoding(enumDescriptor: SerialDescriptor, index: Int): String

handleAttributeOrderConflict

open fun handleAttributeOrderConflict(serializerParent: SafeParentInfo, tagParent: SafeParentInfo, outputKind: OutputKind): OutputKind

handleUnknownContentRecovering

open fun handleUnknownContentRecovering(input: XmlReader, inputKind: InputKind, descriptor: XmlDescriptor, name: QName?, candidates: Collection<Any>): List<XML.ParsedData<*>>

ignoredSerialInfo

abstract fun ignoredSerialInfo(message: String)

initialChildReorderMap

open fun initialChildReorderMap(parentDescriptor: SerialDescriptor): Collection<XmlOrderConstraint>?

Allow modifying the ordering of children.

invalidOutputKind

open fun invalidOutputKind(message: String)

isListEluded

abstract fun isListEluded(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): Boolean

isMapValueCollapsed

open fun isMapValueCollapsed(mapParent: SafeParentInfo, valueDescriptor: XmlDescriptor): Boolean

Determine whether the key attribute should be collapsed into the value tag rather than the value being nested in a container for the element.

isTransparentPolymorphic

abstract fun isTransparentPolymorphic(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): Boolean

mapEntryName

open fun mapEntryName(serializerParent: SafeParentInfo, isListEluded: Boolean): QName

Determine the name to use for the map element (only used when a map entry is wrapped)

mapKeyName

open fun mapKeyName(serializerParent: SafeParentInfo): XmlSerializationPolicy.DeclaredNameInfo

Determine the name of map keys for a given map type

mapValueName

open fun mapValueName(serializerParent: SafeParentInfo, isListEluded: Boolean): XmlSerializationPolicy.DeclaredNameInfo

Determine the name of the values for a given map type

onElementRepeated

open fun onElementRepeated(parentDescriptor: XmlDescriptor, childIndex: Int)

overrideSerializerOrNull

open fun overrideSerializerOrNull(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): KSerializer<*>?

polymorphicDiscriminatorName

abstract fun polymorphicDiscriminatorName(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): QName?

preserveSpace

open fun preserveSpace(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): Boolean

serialTypeNameToQName

open fun serialTypeNameToQName(typeNameInfo: XmlSerializationPolicy.DeclaredNameInfo, parentNamespace: Namespace): QName

serialUseNameToQName

open fun serialUseNameToQName(useNameInfo: XmlSerializationPolicy.DeclaredNameInfo, parentNamespace: Namespace): QName

shouldEncodeElementDefault

abstract fun shouldEncodeElementDefault(elementDescriptor: XmlDescriptor?): Boolean

textListDelimiters

open fun textListDelimiters(serializerParent: SafeParentInfo, tagParent: SafeParentInfo): Array<String>

Determine the delimiters to use to separate primitive/textual list elements when use inside an element. When writing will always write the first element.

typeQName

fun XmlSerializationPolicy.typeQName(xmlDescriptor: XmlDescriptor): QName

updateReorderMap

open fun updateReorderMap(original: Collection<XmlOrderConstraint>, children: List<XmlDescriptor>): Collection<XmlOrderConstraint>