serialization/nl.adaptivity.xmlutil.serialization

Package-level declarations

Types

@Serializer(forClass = CompactFragment::class)

object CompactFragmentSerializer : KSerializer<CompactFragment>

open class DefaultXmlSerializationPolicy : XmlSerializationPolicy

Default implementation of a serialization policy that provides a behaviour that attempts to create an XML format that resembles what would be created manually in line with XML's design.

ElementSerializer

object ElementSerializer : KSerializer<Element>

ICompactFragmentSerializer

object ICompactFragmentSerializer : KSerializer<ICompactFragment>

InputKind

enum InputKind : Enum<InputKind>

KotlinxSerializationProvider

class KotlinxSerializationProvider

NodeSerializer

object NodeSerializer : KSerializer<Node>

NonRecoveryUnknownChildHandler

typealias NonRecoveryUnknownChildHandler = (input: XmlReader, inputKind: InputKind, name: QName?, candidates: Collection<Any>) -> Unit

OutputKind

enum OutputKind : Enum<OutputKind>

PolyInfo

data class PolyInfo(val tagName: QName, val index: Int, val descriptor: XmlDescriptor)

Helper class that collates information used in matching tags with types.

UnknownChildHandler

fun interface UnknownChildHandler

UnknownXmlFieldException

class UnknownXmlFieldException(locationInfo: String?, xmlName: String, candidates: Collection<Any> = emptyList()) : XmlSerialException

WillBePrivate

annotation class WillBePrivate

WrappedDeserializationStrategy

class WrappedDeserializationStrategy<T>(val delegate: DeserializationStrategy<T>, val document: Document) : DeserializationStrategy<T>

XML

class XML(val config: XmlConfig, serializersModule: SerializersModule = EmptySerializersModule()) : StringFormat

Class that provides access to XML parsing and serialization for the Kotlin Serialization system. In most cases the companion functions would be used. Creating an object explicitly however allows for the serialization to be configured.

XmlAfter

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlAfter(val value: String)

Require this property to be serialized after other (sibling) properties. The names are the serialNames of the properties being serialized (not XML names).

XmlBefore

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlBefore(val value: String)

Require this property to be serialized before other (sibling) properties. The names are the serialNames of the properties being serialized (not XML names). Together XmlBefore and XmlAfter define a partial order over the properties.

XmlCData

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlCData(val value: Boolean = true)

Mark the property for serialization as CData, rather than text (where appropriate). It also means that the value is not written as attribute.

XmlChildrenName

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class XmlChildrenName(val value: String, val namespace: String = UNSET_ANNOTATION_VALUE, val prefix: String = UNSET_ANNOTATION_VALUE)

Specify additional information about child values. This is only used for primitives, not for classes that have their own independent name

XmlConfig

class XmlConfig

Configuration for the xml parser.

XmlDefault

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlDefault(val value: String)

Allow a property to be omitted with a default serialized string

XmlElement

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class XmlElement(val value: Boolean = true)

Force a property that could be an attribute to be an element

XmlId

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlId

Annotation to mark the value as an ID attribute. This implies that the element is an attribute.

XmlIgnoreWhitespace

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class XmlIgnoreWhitespace(val value: Boolean = true)

XmlNamespaceDeclSpec

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class XmlNamespaceDeclSpec(val value: String)

Annotation allowing to specify namespaces specifications to be generated upon the element. As multiple annotations are not supported by the plugin this uses a single string. The string separates the namespaces using a semicolon (;). Each declaration is of the form ==. To specify the default namespace it is valid to omit the equals sign.

XmlOtherAttributes

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlOtherAttributes

Determine whether whitespace should be ignored or preserved for the tag.

XmlParsingException

class XmlParsingException(locationInfo: String?, message: String, cause: Exception? = null) : XmlSerialException

XmlPolyChildren

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlPolyChildren(val value: Array<String>)

Indicate the valid poly children for this element

XmlSerialException

open class XmlSerialException(message: String, cause: Throwable? = null) : SerializationException

XmlSerializationPolicy

interface XmlSerializationPolicy

XmlSerialName

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class XmlSerialName(val value: String = UNSET_ANNOTATION_VALUE, val namespace: String = UNSET_ANNOTATION_VALUE, val prefix: String = UNSET_ANNOTATION_VALUE)

Specify more detailed name information than can be provided by kotlinx.serialization.SerialName.

XmlValue

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XmlValue(val value: Boolean = true)

Force a property to be text element content