serialization/nl.adaptivity.xmlutil.serialization/XML/XmlCompanion

XmlCompanion

abstract class XmlCompanion<B : XmlConfig.Builder<out XmlSerializationPolicy?>> : StringFormat(source)

Constructors

XmlCompanion

constructor()

Properties

instance

abstract val instance: XML

serializersModule

open override val serializersModule: SerializersModule

Functions

compact

open fun compact(serializersModule: SerializersModule = EmptySerializersModule()): XML

Shortcut function that creates a format instance that is compact. Note that this is a shortcut for calling recommended { compact() }, for reconfiguration that should be used.

customPolicy

inline fun <P : XmlSerializationPolicy> customPolicy(policy: P, serializersModule: SerializersModule = EmptySerializersModule(), configure: XmlConfig.CustomBuilder<P>.() -> Unit): XML

Create a configuration corresponding to a custom xml serialization policy.

decodeFromReader

inline fun <T : Any> decodeFromReader(reader: XmlReader, rootName: QName? = null): T

@JvmOverloads

fun <T : Any> decodeFromReader(deserializer: DeserializationStrategy<T>, reader: XmlReader, rootName: QName? = null): T

Parse an object of the type T out of the reader

decodeFromStream

inline fun <T> decodeFromStream(source: Reader, rootName: QName): T

fun <T> decodeFromStream(deserializer: DeserializationStrategy<T>, source: Reader, rootName: QName): T

decodeFromStream

inline fun <T> XML.XmlCompanion<*>.decodeFromStream(source: InputStream, rootName: QName): T

fun <T> XML.XmlCompanion<*>.decodeFromStream(deserializer: DeserializationStrategy<T>, source: InputStream, rootName: QName): T

fun <T> XML.XmlCompanion<*>.decodeFromStream(deserializer: DeserializationStrategy<T>, source: InputStream, encoding: String, rootName: QName): T

decodeFromString

@JvmOverloads

inline fun <T : Any> decodeFromString(str: String, rootName: QName? = null): T

open override fun <T> decodeFromString(deserializer: DeserializationStrategy<T>, string: String): T

fun <T> decodeFromString(deserializer: DeserializationStrategy<T>, string: String, rootName: QName?): T

Parse an object of the type T out of the reader

encodeToStream

inline fun <T> encodeToStream(target: Writer, value: T, rootName: QName)

fun <T> encodeToStream(target: Writer, serializer: SerializationStrategy<T>, value: T, rootName: QName)

encodeToStream

inline fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, value: T, rootName: QName)

inline fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, value: T, prefix: String? = null)

fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, serializer: SerializationStrategy<T>, value: T, rootName: QName)

fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, serializer: SerializationStrategy<T>, value: T, prefix: String? = null)

fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, encoding: String, serializer: SerializationStrategy<T>, value: T, rootName: QName)

fun <T> XML.XmlCompanion<*>.encodeToStream(target: OutputStream, encoding: String, serializer: SerializationStrategy<T>, value: T, prefix: String? = null)

encodeToString

inline fun <T : Any> encodeToString(obj: T, prefix: String? = null): String

inline fun <T : Any> encodeToString(obj: T, rootName: QName): String

override fun <T> encodeToString(serializer: SerializationStrategy<T>, value: T): String

fun <T> encodeToString(serializer: SerializationStrategy<T>, value: T, prefix: String?): String

fun <T> encodeToString(serializer: SerializationStrategy<T>, value: T, rootName: QName): String

Transform the object into an XML string. This requires the object to be serializable by the kotlin serialization library (either it has a built-in serializer or it is Serializable.

encodeToWriter

inline fun <T : Any> encodeToWriter(target: XmlWriter, value: T, prefix: String? = null)

inline fun <T : Any> encodeToWriter(target: XmlWriter, value: T, rootName: QName)

fun <T> encodeToWriter(target: XmlWriter, serializer: SerializationStrategy<T>, value: T, prefix: String? = null)

fun <T> encodeToWriter(target: XmlWriter, serializer: SerializationStrategy<T>, value: T, rootName: QName)

Write the object to the given writer

fast

open fun fast(): XML

inline fun fast(configure: B.() -> Unit = {}): XML

fun fast(serializersModule: SerializersModule): XML

inline fun fast(serializersModule: SerializersModule, configure: B.() -> Unit = {}): XML

invoke

operator fun invoke(): XML

inline operator fun invoke(configure: B.() -> Unit = {}): XML

operator fun invoke(serializersModule: SerializersModule): XML

inline operator fun invoke(serializersModule: SerializersModule, configure: B.() -> Unit = {}): XML

xmlDescriptor

inline fun <T> xmlDescriptor(rootName: QName? = null): XmlDescriptor

fun xmlDescriptor(deserializer: DeserializationStrategy<*>, rootName: QName? = null): XmlDescriptor

fun xmlDescriptor(serializer: KSerializer<*>, rootName: QName? = null): XmlDescriptor

fun xmlDescriptor(serializer: SerializationStrategy<*>, rootName: QName? = null): XmlDescriptor