Package-level declarations

Opaque caching class that allows for caching format related data (to speed up reuse). This is intended to be stored on the config, thus reused through multiple serializations. Note that this requires the serialName attribute of SerialDescriptor instances to be unique.

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.

Interface for format caches that support being delegated to.

The FormatCache caches the calculations needed to determine the correct format for a specific serializable tree. There are 3 options provided by default:

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

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.

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

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.

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

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

Configuration for the xml parser.

Allow a property to be omitted with a default serialized string

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

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

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

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

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 (prefix)=(namespace). To specify the default namespace it is valid to omit the equals sign.

This annotation allows handling wildcard attributes. The key is preferred to be a QName, alternatively it must convert to String (this could be "prefix:localName"). The value must be a String type. Note that if the key runtime type is a QName the value is directly used as attribute name without using the key serializer.

Indicate the valid poly children for this element

Policies allow for customizing the behaviour of the xml serialization

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

Force a property to be content of the tag. This is both for text content, but if the type is a list of tag-like types (Node, Element, CompactFragment it will also allow mixed content) of tags not supported by the base type.