core/nl.adaptivity.xmlutil/IXmlStreaming

IXmlStreaming

IXMLStreaming is the interface (accessible through xmlStreaming) that exposes the XML parsing and serialization in a platform independent way.

Properties

genericDomImplementation

abstract val genericDomImplementation: DOMImplementation

Get a generic (platform independent) DOM implementation.

genericFactory

@ExperimentalXmlUtilApi

val IXmlStreaming.genericFactory: XmlStreamingFactory

Get a streaming factory that returns the platform independent serializer/deserializer implementations.

platformDOMImplementation

abstract val platformDOMImplementation: PlatformDOMImplementation

Get a DOM implementation that may be platform specific (where available)

Functions

newGenericReader

abstract fun newGenericReader(input: CharSequence, expandEntities: Boolean = false): XmlReader

abstract fun newGenericReader(reader: Reader, expandEntities: Boolean = false): XmlReader

Create a new XML reader with the given input. This reader is generic.

newGenericReader

fun IXmlStreaming.newGenericReader(inputStream: InputStream): XmlReader

Create a new XML reader with the given source node as starting point. This reader is generic.

fun IXmlStreaming.newGenericReader(inputStream: InputStream, encoding: String): XmlReader

Create a new XML reader with the given source node as starting point. This reader is generic. This would does charset detection using BOM for UTF variants and the xml declaration.

newGenericWriter

fun IXmlStreaming.newGenericWriter(output: Appendable, isRepairNamespaces: Boolean = false, xmlDeclMode: XmlDeclMode = XmlDeclMode.None): KtXmlWriter

Create a new XmlWriter that appends to the given Appendable. This writer could be a platform specific writer.

newReader

@ExperimentalXmlUtilApi

abstract fun newReader(source: Node): XmlReader

Create a new XML reader with the given source node as starting point. Depending on the configuration, this parser can be platform specific.

abstract fun newReader(input: CharSequence, expandEntities: Boolean = false): XmlReader

abstract fun newReader(reader: Reader, expandEntities: Boolean = false): XmlReader

Create a new XML reader with the given input. Depending on the configuration, this parser can be platform specific.

newReader

fun IXmlStreaming.newReader(delegate: Node): XmlReader

Create a new XML reader with the given source node as starting point. Depending on the configuration, this parser can be platform specific.

fun IXmlStreaming.newReader(inputStream: InputStream): XmlReader

Create a new XML reader with the given source node as starting point. Depending on the configuration, this parser can be platform specific. This would normally do some level of charset detection (e.g. using the xml declaration, a.o. UTF BOM based detection).

fun IXmlStreaming.newReader(node: Node): XmlReader

fun IXmlStreaming.newReader(inputStream: InputStream, encoding: String): XmlReader

Create a new XML reader with the given source node as starting point. Depending on the configuration, this parser can be platform specific.

newWriter

@ExperimentalXmlUtilApi

abstract fun newWriter(): DomWriter

Create a new DomWriter that results in writing a DOM tree.

@ExperimentalXmlUtilApi

abstract fun newWriter(dest: Node): DomWriter

Create a new DomWriter that results in writing to DOM with dest as the receiver node.

newWriter

actual fun IXmlStreaming.newWriter(output: Appendable, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given Appendable.

actual fun IXmlStreaming.newWriter(writer: Writer, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given Writer. This writer could be a platform specific writer.

expect fun IXmlStreaming.newWriter(output: Appendable, repairNamespaces: Boolean = false, xmlDeclMode: XmlDeclMode = XmlDeclMode.None): XmlWriter

Create a new XmlWriter that appends to the given Appendable. This writer could be a platform specific writer.

expect fun IXmlStreaming.newWriter(writer: Writer, repairNamespaces: Boolean = false, xmlDeclMode: XmlDeclMode = XmlDeclMode.None): XmlWriter

Create a new XmlWriter that appends to the given Writer. This writer could be a platform specific writer.

fun IXmlStreaming.newWriter(dest: ParentNode): DomWriter

Create a new DomWriter that results in writing to DOM with dest as the receiver node.

actual fun IXmlStreaming.newWriter(output: Appendable, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given Appendable. This writer could be a platform specific writer.

actual fun IXmlStreaming.newWriter(writer: Writer, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given Writer. This writer could be a platform specific writer.

fun IXmlStreaming.newWriter(outputStream: OutputStream, encoding: String, repairNamespaces: Boolean = false): XmlWriter

Create a new XmlWriter that appends to the given OutputStream. This writer could be a platform specific writer.

fun IXmlStreaming.newWriter(writer: Writer, repairNamespaces: Boolean = false, xmlDeclMode: XmlDeclMode = XmlDeclMode.None): XmlWriter

Create a new XmlWriter that appends to the given java specific java.io.Writer.

actual fun IXmlStreaming.newWriter(output: Appendable, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given Writer. This writer could be a platform specific writer.

actual fun IXmlStreaming.newWriter(writer: Writer, repairNamespaces: Boolean, xmlDeclMode: XmlDeclMode): XmlWriter

Create a new XmlWriter that appends to the given multi-platform MPWriter.

setFactory

fun IXmlStreaming.setFactory(factory: XmlStreamingFactory?)

Set the factory that is used to initialise the non-generic readers/writers.