core/nl.adaptivity.xmlutil.core/KtXmlWriter

KtXmlWriter

class KtXmlWriter(writer: Appendable, val isRepairNamespaces: Boolean = true, val xmlDeclMode: XmlDeclMode, xmlVersion: XmlVersion = XmlVersion.XML11) : PlatformXmlWriterBase, XmlWriter(source)

A cross-platform implementation of XmlWriter. Created by pdvrieze on 15/11/15.

Constructors

KtXmlWriter

constructor(writer: Writer, isRepairNamespaces: Boolean = true, xmlDeclMode: XmlDeclMode, xmlVersion: XmlVersion = XmlVersion.XML11)

constructor(writer: Appendable, isRepairNamespaces: Boolean = true, xmlDeclMode: XmlDeclMode, xmlVersion: XmlVersion = XmlVersion.XML11)

Properties

addTrailingSpaceBeforeEnd

var addTrailingSpaceBeforeEnd: Boolean

Determine whether a trailing space is used before the end of a self-closing tag.

depth

open override val depth: Int

The current depth into the tree. The initial depth is 0

indent

open override var indent: Int

The indentation level to use for autoindenting the output

indentSequence

var indentSequence: List<XmlEvent.TextEvent>

indentString

override var indentString: String

The indentation string to use for autoindenting the output

isRepairNamespaces

val isRepairNamespaces: Boolean = true

Should missing namespace attributes be added automatically

namespaceContext

open override val namespaceContext: NamespaceContext

The namespace context in the current position.

xmlDeclMode

val xmlDeclMode: XmlDeclMode

Should the xml declaration be emitted automatically?

xmlVersion

var xmlVersion: XmlVersion

The version of XML to generate. By default XML 1.1.

Functions

attribute

open override fun attribute(namespace: String?, name: String, prefix: String?, value: String)

Write an attribute.

cdsect

open override fun cdsect(text: String)

Write a CDATA section

open override fun close()

Close the writer. After invoking this the writer is not writable.

comment

open override fun comment(text: String)

Write a comment.

docdecl

open override fun docdecl(text: String)

Write a document declaration (DTD).

endDocument

open override fun endDocument()

Close the document. This will do checks, and update the state, but there is no actual content in an xml stream that corresponds to it.

endTag

open override fun endTag(namespace: String?, localName: String, prefix: String?)

Write a closing tag.

endTag

fun XmlWriter.endTag(predelemname: QName)

entityRef

open override fun entityRef(text: String)

Write an entity reference

filterSubstream

fun XmlWriter.filterSubstream(): XmlWriter

flush

open override fun flush()

Flush all state to the underlying buffer

getNamespaceUri

open override fun getNamespaceUri(prefix: String): String?

Get the namespace uri the prefix is currently bound to

getPrefix

open override fun getPrefix(namespaceUri: String?): String?

Get a prefix the uri is currently bound to

ignorableWhitespace

open override fun ignorableWhitespace(text: String)

Write ignorable whitespace.

namespaceAttr

open fun namespaceAttr(namespace: Namespace)

open override fun namespaceAttr(namespacePrefix: String, namespaceUri: String)

Write a namespace declaration attribute.

processingInstruction

open override fun processingInstruction(text: String)

Write a processing instruction with the given raw content. When using, prefer the version taking two arguments

open override fun processingInstruction(target: String, data: String)

Write a processing instruction with the given target and data

serialize

fun XmlWriter.serialize(reader: XmlReader)

Serialize the content of the reader to the writer. This will continue until the reader has no more events. Note that this does not attempt to balance the tags. It will ignore star/end document events, processing instructions and document declarations if the writer has depth>0 (is in an element where such instructions are illegal).

fun XmlWriter.serialize(node: Node)

setPrefix

open override fun setPrefix(prefix: String, namespaceUri: String)

Bind the prefix to the given uri for this element.

smartStartTag

fun XmlWriter.smartStartTag(qName: QName)

inline fun XmlWriter.smartStartTag(qName: QName, body: XmlWriter.() -> Unit)

Enhanced function for writing start tags, that will attempt to reuse prefixes.

@JvmOverloads

fun XmlWriter.smartStartTag(nsUri: String?, localName: String, prefix: String? = null): String

Enhanced function for writing start tags, that will attempt to reuse prefixes. Rather than use the passed prefix it will look up the prefix for the given namespace, and if present use that. It will also ensure to write the appropriate namespace attribute if needed. If the namespace is the default/null, xml or the xmlns namespace the implementation will be as expected.

@JvmOverloads

inline fun XmlWriter.smartStartTag(nsUri: String?, localName: String, prefix: String? = null, body: XmlWriter.() -> Unit)

Helper function for writing tags that will automatically write the end tag. Otherwise

startDocument

open override fun startDocument(version: String?, encoding: String?, standalone: Boolean?)

{@inheritDoc}

startTag

open override fun startTag(namespace: String?, localName: String, prefix: String?)

Write a start tag. This increases the current depth.

startTag

inline fun XmlWriter.startTag(nsUri: String?, localName: String, prefix: String? = null, body: XmlWriter.() -> Unit)

text

open override fun text(text: String)

Write text.

writeAttribute

fun XmlWriter.writeAttribute(name: String, value: Any?)

fun XmlWriter.writeAttribute(name: String, value: Double)

fun XmlWriter.writeAttribute(name: String, value: Long)

fun XmlWriter.writeAttribute(name: String, value: String?)

fun XmlWriter.writeAttribute(name: String, value: QName?)

fun XmlWriter.writeAttribute(name: QName, value: String?)

writeCurrentEvent

fun XmlWriter.writeCurrentEvent(reader: XmlReader)

Write the current event to the writer. Note that for tags/start elements this will write the attributes, but not the children.

writeElement

fun XmlWriter.writeElement(missingNamespaces: MutableMap<String, String>?, reader: XmlReader)

Write the entirety of an element content to the writer.

writeElementContent

fun XmlWriter.writeElementContent(missingNamespaces: MutableMap<String, String>?, reader: XmlReader)

Write the child content of the current element in the reader to the output This does not write the container itself

writeListIfNotEmpty

inline fun <T> XmlWriter.writeListIfNotEmpty(iterable: Iterable<T>, nsUri: String?, localName: String, prefix: String? = null, body: XmlWriter.(T) -> Unit)

Helper function for writing a list only if it contains any element.

writeSimpleElement

fun XmlWriter.writeSimpleElement(qName: QName, value: String?)

fun XmlWriter.writeSimpleElement(nsUri: String?, localName: String, prefix: String?, value: String?)