- Core:Â
- Serialization:Â
- SerialUtil:Â
XmlUtil is a set of packages that supports multiplatform XML in Kotlin.
- Gradle wrapper validation:
This project is a cross-platform XML serialization (wrapping) library compatible with kotlinx.serialization. It supports all platforms although native is at beta quality.
Based upon the core xml library, the serialization module supports automatic object serialization based upon Kotlin's standard serialization library and plugin.
Help wanted: Any help with extending this project is welcome. Help is especially needed for the following aspects:
- Documentation updates
- Testing, in particular more extensive tests. Some tests already exist for both JVM and Android
- Native xml library support: Native is only supported through the cross-platform implementation that is somewhat limited in advanced features such as DTD and validation support. Ideally integration with a well-developed native library as an option would be beneficial.
Please note that the JVM target will not work on Android due to different serialization libraries. It is possible to consume the multiplatform targets on single-target Kotlin although there may be issues with older Gradle versions not finding the correct version. As a workaround for single-platform Android projects, try adding the following code to your Gradle build file:
kotlin {
target {
attributes {
if (KotlinPlatformType.attribute !in this) {
attribute(KotlinPlatformType.attribute, KotlinPlatformType.androidJvm)
}
}
}
}
KotlinPlatformType.setupAttributesMatchingStrategy(dependencies.attributesSchema)This code tells Gradle that are targeting Android when it resolves multi-platform libraries. In other cases you can use the different platform types.
This library is based upon the unstable kotlinx.serialization library. While every effort is made to limit incompatible changes, this cannot be guaranteed even in "minor" versions when the changes are due to bugs. These changes should mostly be limited to the serialization part of the library.
The library is designed as a multiplatform Kotlin module, but platform-specific versions can also be used were appropriate.
The project's Maven access is hosted on OSS Sonatype (and available from Maven Central).
Releases can be added from maven central
They are also available directly from Sonatype by adding the following to your Gradle build file:
repositories {
maven {
url "https://s01.oss.sonatype.org/content/repositories/releases/"
}
}Snapshots are available from:
repositories {
maven {
url "https://s01.oss.sonatype.org/content/repositories/snapshots/"
}
}It should be noted that the JVM and Android packages are no longer part
of the multiplatform publication (they are combined into a jvmCommon)
package. The JVM and Android packages provide the native
implementations and depend on (publishing) the jvmCommon package.
implementation("io.github.pdvrieze.xmlutil:core:0.91.1")
implementation("io.github.pdvrieze.xmlutil:core-jdk:0.91.1")
implementation("io.github.pdvrieze.xmlutil:core-android:0.91.1")
implementation("io.github.pdvrieze.xmlutil:core-js:0.91.1")
Has platform independent implementations of xml parsing/serialization (based upon the Android implementation) and DOM (a simple implementation that mirrors the Java API)
implementation("io.github.pdvrieze.xmlutil:serialization:0.91.1")
implementation("io.github.pdvrieze.xmlutil:serialization-jvm:0.91.1")
** Deprecated **
implementation("io.github.pdvrieze.xmlutil:serialization-android:0.91.1")
This version is merely a dependency to the main module that no longer has the android specific artefact as this is not supported by kotlin (and has resolution issues).
implementation("io.github.pdvrieze.xmlutil:serialization-js:0.91.1")
Deprecated
This library is no longer supported. Instead use official Ktor xml serialization support. It is mostly equal to this version.
To serialize a very simple type you have the following:
@Serializable
data class HelloWorld(val user: String)
println(XML.encodeToString(HelloWorld("You!")))To deserialize you would do:
@Serializable
data class HelloWorld(val user: String)
XML.decodeFromString(HelloWorld.serializer(), "<HelloWorld user='You!' />")Please look at the examples and the documentation for further features that can influence: the tag names/namespaces used, the actual structure used (how lists and polymorphic types are handled), etc.
You should be able to find examples in the Examples module
The entrypoint to the library is the XML format. There is a default, but often a child is better.
Custom formats are created through:
val format = XML(mySerialModule) {
// configuration options
autoPolymorphism = true
}The following options are available when using the XML format builder:
| Option | Description |
|---|---|
repairNamespaces |
Should namespaces automatically be repaired. This option will be passed on to the XmlWriter |
xmlDeclMode |
The mode to use for emitting XML declarations (). Replaces omitXmlDecl for more finegrained control |
indentString |
The indentation to use. Must be a combination of XML whitespace or comments (this is checked). This is passed to the XmlWriter |
-autoPolymorphic- |
Deprecated Shorcut to policy.autoPolymorphic |
isInlineCollapsed |
If true(default) the content of an inline type is used directly, with the name of the inline type. |
xmlVersion |
Which xml version will be written/declared (default XML 1.1) |
isCollectingNSAttributes |
(Attempt to) collect all needed namespace declarations and emit them on the root tag, this does have a performance overhead |
defaultToGenericParser |
Use the generic parser, rather than the platform specific one. |
policy |
This is a class that can be used to define a custom policy that informs how the kotlin structure is translated to XML. It drives most complex configuration |
defaultPolicy {} |
Builder that allows configuring the default policy. This policy is stable, it doesn't change across versions. |
recommended_0_86_3 {} |
Builder that sets the policy to the recommended defaults per version 0.86.3, this is stable and includes: autopolymorphic, inlineCollapsed, indent=4, p.pedantic, p.typeDiscriminatorName=xsi:type, encodeDefault=ANNOTATED, throwOnRepeatedElement, isStrictAttributeNames |
recommended_0_90_2 {} |
Builder that sets the policy to the recommended defaults per version 0.90.2, this is stable and extends from 0.86.3. It uses xml 1.1, strict booleans, and minimal xml declaration |
fast_0_90_2 {} |
Builder that sets the policy to the recommended for fast parsing. This reduces error checks, but otherwise has the same semantics as 0.90.2. |
recommended {} |
Builder that sets the policy to the currently recommended defaults (the 0.90.2 configuration) |
-indent- |
Deprecated for reading: The indentation level (in spaces) to use. This is backed by indentString. Reading is "invalid" for indentString values that are not purely string sequences. Writing it will set indentation as the specified amount of spaces. |
-omitXmlDecl- |
Deprecated (use xmlDeclMode). Should the generated XML contain an XML declaration or not. This is passed to the XmlWriter |
-unknownChildHandler- |
Deprecated into policy A function that is called when an unknown child is found. By default an exception is thrown but the function can silently ignore it as well. |
The properties that have been moved into the policy can still be set in the builder, but are no longer able to be read through the config object.
The following options are available as part of the default policy builder. Note that the policy is designed to allow configuration through code, but the default policy has significant configuration options available.
| Option | Description |
|---|---|
pedantic |
Fail on output type specifications that are incompatible with the data, rather than silently correcting this |
autoPolymorphic |
When not specifying a custom policy this determines whether polymorphism is handled without wrappers. 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) |
encodeDefault |
Determine whether in which cases default values should be encoded. |
unknownChildHandler |
A function that is called when an unknown child is found. By default an exception is thrown but the function can silently ignore it as well. |
typeDiscriminatorName |
This property determines the type discriminator attribute used. It is always recognised, but not serialized in transparent polymorphic (autoPolymorphic) mode. If this is null, a wrapper tag with type attribute is used instead of a discriminator. |
throwOnRepeatedElement |
Rather than silently allowing a repeated element (not part of a list), throw an exception if the element occurs multiple times. |
verifyElementOrder |
While element order (when specified using @XmlBefore and @XmlAfter) is always used for serialization, this flag allows checking this order on inputs. |
isStrictAttributeNames |
Enables stricter, standard compliant attribute name mapping in respect to default/null namespaces. Mainly relevant to decoding. |
isStrictBoolean |
Parse boolean variables according to the XML Schema standard. |
isXmlFloat |
Encode xml float/double values according to the XML Schema standard, not the JVM one (infinity is encoded differently) |
XML and Kotlin data types are not perfectly alligned. As such there are some
algorithms that aim to automatically make a "best attempt" at structuring the XML
document. Most of this is implemented in the default XmlSerializationPolicy
implementation, but this can be customized/replaced with a policy that results
in a different structure. The policy includes the mapping from types/attributes
to tag and attribute names.
In the default policy, the way a field is stored is automatically determined to be one of: Element, Attribute, Text or Mixed. Mixed is a special type that allows for mixing of text and element content and requires some special treatment.:
-
If a field is annotated with
@XmlElementorXmlValuethis will take precedence. The XmlValue tag will allow the field to hold element text content (direct only). -
If the serializer is a primitive this will normally be serialized as attribute
-
If the serializer is a list, if there is an
@XmlChildrenNameannotation, this will trigger named list mode where a wrapper tag (element) is used. Otherwise the list elements, even primitives, will be written directly as tags (even primitives) without any wrapper list tags. -
If a list has the
@XmlValuetag, this will allow the list to hold mixed content. To actually support text content it needs to be a list ofAny. This should also be polymorphic (but the annotation is required).- Lists of
Elements (usingElementSerializer) andCompactFragments support arbitrary content and provide it as lists of fragments or nodes.
- Lists of
-
If a primitive is written as tag, the type name is used as tag name, and value as its element content.
-
A primitive written as TEXT will be text content only, but note that there are only few cases where this is valid.
-
Polymorphic properties are treated specially in that the system does not use/require wrappers. Instead it will use the tag name to determine the type. The name used is either specified by an
@XmlPolyChildrenannotation or through the type'sserialDescriptor. This also works inside lists, including transparent (invisible) lists. If multiple polymorphic properties have the same subtags, this is an error that may lead to undefined behaviour (you can use the@XmlPolyChildrento have different names).A custom policy is able to determine on individual basis whether transparent polymorphism should be used, but the default policy provides an overall toggle (which also respects the autopolymorphic property of the configuration builder). The default will always trigger transparent mode if
XmlPolyChildrenis present. -
If the serializer is polymorphic, tag mode will be enforced. If
@XmlPolyChildrenis specified orautoPolymorphicis set it triggers transparent polymorphism mode where the child name is used to look up the property it belongs to. (note that this is incorrect with multiple properties that could contain the same polymorphic value - unless @XmlPolyChildren overrides it). -
Otherwise it will be written as a tag.
The way the name is determined is configured/implemented through the configured policy. The documentation below is for the default policy. This is designed to allow customization by users.
Based upon the storage type, the effective name for an attribute is determined as follows:
@XmlSerialNameat property declaration site@XmlSerialNameat type declaration site@SerialNameat property declaration site- property name at property declaration site (note that the
@SerialNameannotation is invisible to the encoder)
The effective name for a regular tag is determined as follows for normal serializers:
@XmlSerialNameat property declaration site@XmlSerialNameat type declaration site@SerialNameat type declaration site- type name at type declaration site. The default type declaration type name is the Kotlin/Java type name (and long). The system will try to shorten this by eliding the package name. This is configurable in the policy.
The effective name for a polymorphic child is determined as follows:
- If the child is transparent, the annotations/serial name of the effective type is used (unless overridden by
@XmlPolyChildren) - If the child is not transparent, the container is treated as a regular tag. It will have a
typeattribute to contain the serial name of the type (shortened to share the package name with the container). The value will use the default namevalue.
The implementation if serialization in the Kotlin compiler does not allow distinguishing between the automatic name and
a @SerialName annotation. The default implementation supposes that if there is a '.' character in the name, this is
a java type name and it strips the package out. (This also when it could be an attribute).
If you need to support names with dots in your format, either use the @XmlSerialName annotation, or use a
different policy.
The annotations that specify names have common attributes: value:String,
namespace:String and prefix:string. They have common semantics:
| parameter | description |
|---|---|
value: String |
The local part of the tag name to use. If optional and not specified the serial name of the property/type will be used. |
namespace: String |
The namespace part of the tag name to use. If not specifies defaults to the namespace of the containing tag |
prefix: String |
Suggested prefix to use, overridden by existing prefixes for the namespace. Will cause a namespace declaration/prefix to be added if needed. |
Annotation explanation.
| Annotation | Property | Description |
|---|---|---|
@XmlSerialName |
Specify more detailed name information than can be provided by kotlinx.serialization.SerialName. In particular, it is not reliably possible to distinguish between @SerialName and the type name. We also need to specify namespace and prefix information. |
|
value: String, namespace: String, prefix: String |
See table above. | |
@XmlNamespaceDeclSpec |
*Deprecated in favour of [XmlNamespaceDeclSpec]. 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. |
|
value: String |
The actual specification: "prefix1=urn:namespace1;defaultNamespace" |
|
@XmlNamespaceDeclSpecs |
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. Each declaration is of the form (prefix)=(namespace). To specify the default namespace it is valid to omit the equals sign. | |
vararg value: String |
The actual specification: "prefix1=urn:namespace1", "defaultNamespace" |
|
@XmlPolyChildren |
Indicate the valid polymorphic children for this element. This is a legacy annotation supporting polymorphic (de)serialization without modules. | |
value: Array<String> |
Each string specifies a child according to the following format: childSerialName[=[prefix:]localName]. The childSerialName is the name value of the descriptor. By default that would be the class name, but @SerialName will change that. If the name is prefixed with a . the package name of the container will be prefixed. Prefix is the namespace prefix to use (the namespace will be looked up based upon this). Localname allows to specify the local name of the tag. |
|
@XmlChildrenName |
Specify additional information about child values in collections. This is only used for primitives, not for classes that have their own independent name. The outer tag name is determined regularly. | |
value: String |
Mandatory, see table above. | |
namespace: String, prefix: String |
See table above. | |
@XmlKeyName |
Used to specify the xml name used for the key attribute/tag of a map. | |
value: String |
Mandatory, see table above. | |
namespace: String, prefix: String |
See table above. | |
@XmlMapEntryName |
Dual use annotation that both forces explicit map entry wrappers and specifies the tag name used. The default is to elude the wrappers in the case that data does not contain an attribute with the name of the key. | |
value: String |
Mandatory, see table above. | |
namespace: String, prefix: String |
See table above. | |
@XmlElement |
Force a property that could be an attribute to be an element. Note that default behaviour requires this annotation to be absent. | |
value: Boolean |
true to indicate serialization as tag, false to indicate serialization as attribute. Note that not all values can be serialized as attribute. |
|
@XmlValue |
Force a property to be content of the tag (for the object containing the property). This is both for text content (polymorphic including a primitive), 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. Strings will be serialized/deserialized as (tag soup) string content without wrapper. |
|
value: Boolean |
true to indicate the value. false and absence are equivalent. |
|
@XmlId |
Annotation to mark the value as an ID attribute. This implies that the element is an attribute. This will allow the serializer to enforce uniqueness. | |
@XmlIgnoreWhitespace |
Determine whether whitespace should be ignored or preserved for the tag. | |
value: Boolean |
true if whitespace is to be ignored, false if preserved. |
|
@XmlOtherAttributes |
This annotation allows handling wildcard attributes. It should be specified on a Map<QName, String> to store unsupported 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. |
|
@XmlCData |
Mark the property for serialization as CData, rather than text (where appropriate). If used on a property this will override the annotation on a type. This is the only context in which a value of false is different from omitting the annotation. |
|
@XmlDefault |
Allow a property to be omitted with a default serialized string. This annotation primarily supports older versions of the framework that do not support default attribute values. The default value will not be written out if matched. | |
value: String |
The default value used if no value is specified. The value is parsed as if there was textual substitution of this value into the serialized XML. | |
@XmlBefore |
Require this property to be serialized before other (sibling) properties. Together [XmlBefore] and [XmlAfter] define a partial order over the properties. Using this annotation may cause values to be serialized as elements rather than attributes where not explicitly specified as attributes. If there is a conflict between serialization type (attribute/element) this takes precendence over this attribute. The names are the serialNames of the properties being serialized (not XML names). | |
value: Array<String> |
The serial names of all the children that should be serialized after this one (uses the [kotlinx.serialization.SerialName] value or field name). | |
@XmlAfter |
Require this property to be serialized after other (sibling) properties. Together [XmlBefore] and [XmlAfter] define a partial order over the properties. Using this annotation may cause values to be serialized as elements rather than attributes where not explicitly specified as attributes. If there is a conflict between serialization type (attribute/element) this takes precendence over this attribute. The names are the serialNames of the properties being serialized (not XML names). | |
value: Array<String> |
The serial names of all the children that should be serialized before this one (uses the [kotlinx.serialization.SerialName] value or field name). |
These types have contextual support by default (without needed user intervention), but the serializer can also be specified explicitly by the user. They get special treatment to support their features.
By default (configurable by the policy) QName is handled by special logic that stores QNames in a prefix:localName manner ensuring the prefix is valid in the tag. Many XML standards use this approach for string attributes.
The CompactFragment class is a special class (with supporting serializer) that will be able to capture the tag soup
content of an element. Instead of using regular serialization its custom serializer will (in the case of xml serialization)
directly read all the child content of the tag and store it as string content. It will also make a best effort attempt
at retaining all namespace declarations necessary to understand this tag soup.
Alternatively the serialutil subproject contains the nl.adaptivity.serialutil.MixedContent type that allows for
typesafe serialization/deserialization of mixed content with the proviso that the serialModule must use Any as the
baseclass for the content.
Container for the core library (versions)
All code shared between JavaScript and Java (either jvm or android)
All code that is common, but not shared between Jvm and Android platforms
Code specific to the Android platform (Pulls in core.java as API dependency). This is a regular jar rather than an AAR as the only specific thing to Android is the XML library
Implementation of the shared code for Java based platforms (both Android and JVM)
JavaScript based implementation
Code unique to the JVM platform (Pulls in core.java as API dependency)
The kotlinx.serialization plugin to allow serialization to XML
The java version of the serialization plugin. Please note that it does not pull in the platform specific library. The core library is dependent on the actual platform used (JVM or Android). This library only pulls in the shared Java code.
The JVM version merely uses the jvm platform xml library but the serialization is
The JavaScript version of the serialization plugin.
An android test project to test serialization on Android.