The declared encoding for the document. Unlike general parsing, this value is accessible after reading the document element. The document element must be the first non-whitespace element. The value for this property before document element presence is known is implementation defined (and may change).

eventType

open override val eventType: EventType

Get the type of the current event.

extLocationInfo

open override val extLocationInfo: XmlReader.LocationInfo?

Enhanced location info that allows a reader to provide more detail than just a string

isKnownEntity

open override val isKnownEntity: Boolean

For an unresolved entity determine whether it is known

isStarted

open override val isStarted: Boolean

Determine whether parsing has started yet. When this is false it is invalid to check the state.

localName

open override val localName: String

Retrieve the local name of the current tag

name

open override val name: QName

Retrieve the qualified name of the current tag

namespaceContext

open override val namespaceContext: IterableNamespaceContext

The current namespace context

namespaceDecls

open override val namespaceDecls: List<Namespace>

Retrieve the namespaces declared at the current level.

namespaceURI

open override val namespaceURI: String

Retrieve the namespace URI of the current tag

piData

open override val piData: String

Data for processing instructions.

piTarget

open override val piTarget: String

Target for processing instructions.

prefix

open override val prefix: String

Retrieve the prefix of the current tag

qname

val XmlReader.qname: QName

Read a QName text from the reader. This will read prefix:localName values and resolve the namespace.

standalone

open override val standalone: Boolean?

The declared standalone status for the document. Unlike general parsing, this value is accessible after reading the document element. The document element must be the first non-whitespace element. The value for this property before document element presence is known is implementation defined (and may change).

text

open override val text: String

Get the text content for textual events.

version

open override val version: String?

The declared xml version for the document. Unlike general parsing, this value is accessible after reading the document element. The document element must be the first non-whitespace element. The value for this property before document element presence is known is implementation defined (and may change).

Functions

allText

fun XmlReader.allText(): String

Get the next text sequence in the reader. This will skip over comments and ignorable whitespace (starting the content), but not tags. Any tags encountered with cause an exception to be thrown. It can either be invoked when in a start tag to return all text content, or on a content element to include it (if text or cdata) and all subsequent siblings.

asSubstream

fun XmlReader.asSubstream(): XmlReader

Create a new reader that only returns the current element and its descendents. Such sub-reader ensures that the user of the return value does not exceed this stream.

open override fun close()

Close the reader

elementContentToFragment

fun XmlReader.elementContentToFragment(): ICompactFragment

Differs from .siblingsToFragment in that it skips the current event.

elementToFragment

fun XmlReader.elementToFragment(): CompactFragment

Read the current element (and content) only into a fragment.

getAttributeLocalName

open override fun getAttributeLocalName(index: Int): String

Get the local name for the attribute at the given index.

getAttributeName

open override fun getAttributeName(index: Int): QName

Get the qualified name for the attribute at the given index.

getAttributeNamespace

open override fun getAttributeNamespace(index: Int): String

Get the namespace URI for the attribute at the given index.

getAttributePrefix

open override fun getAttributePrefix(index: Int): String

Get the prefix for the attribute at the given index.

getAttributeValue

open override fun getAttributeValue(index: Int): String

Get the value of the attribute at the given index.

open override fun getAttributeValue(name: QName): String?

open override fun getAttributeValue(nsUri: String?, localName: String): String?

Get the value of the attribute with the given name if it exists.

getNamespacePrefix

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

Get a prefix for the given namespace URI, or null if there is none.

getNamespaceURI

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

Get the namespace for the given prefix, if any

hasNext

open operator override fun hasNext(): Boolean

isCharacters

open override fun isCharacters(): Boolean

Is the currrent element character content

isElement

fun XmlReader.isElement(elementname: QName): Boolean

Determine whether the current event of the XMLReader is an element with the given name. Note that this ignores the prefix of the name.

fun XmlReader.isElement(type: EventType, elementname: QName): Boolean

@JvmOverloads

fun XmlReader.isElement(elementNamespace: String?, elementName: String, elementPrefix: String? = null): Boolean

fun XmlReader.isElement(type: EventType, elementNamespace: String?, elementName: String, elementPrefix: String? = null): Boolean

Check that the current state is a start element for the given name. The mPrefix is ignored.

isEndElement

open override fun isEndElement(): Boolean

Determine whether the current event is an end tag

isIgnorable

fun XmlReader.isIgnorable(): Boolean

Determine whether the current event in the reader is ignorable. This ignores: comments, start/end document, processing instructions, document declarations, ignorable whitespace, and text that is effectively xml whitespace.

isPrefixDeclaredInElement

fun XmlReader.isPrefixDeclaredInElement(prefix: String): Boolean

Determine whether the given prefix is known in the reader (up to this point). This can be used for reading text that could reference a namespace prefix (e.g. when parsing XPath expressions).

isStartElement

open override fun isStartElement(): Boolean

Is the current element a start tag

isWhitespace

open override fun isWhitespace(): Boolean

Determine whether the current state is effective whitespace, for text it will check the text.

open operator override fun next(): EventType

nextTag

open override fun nextTag(): EventType

Overridden such that it will be valid, even when overriding next.

readSimpleElement

fun XmlReader.readSimpleElement(): String

From a start tag read the text only content of the element. Comments are allowed and handled, but subtags are not allowed. This tag finishes at the end of the element.

require

open override fun require(type: EventType, name: QName?)

open override fun require(type: EventType, namespace: String?, name: String?)

Check the current state for non-null values.

requireNext

open override fun requireNext(type: EventType, name: QName?)

open override fun requireNext(type: EventType, namespace: String?, name: String?)

Check that the next element is as required. null values are not checked.

requireNextTag

open override fun requireNextTag(type: EventType, name: QName?)

open override fun requireNextTag(type: EventType, namespace: String?, name: String?)

Check that the next tag element is as required. null values are not checked.

siblingsToFragment

fun XmlReader.siblingsToFragment(): CompactFragment

Read the current event and all subsequent siblings into a compact fragment.

skipElement

fun XmlReader.skipElement()

From a start element, skip all element content until the corresponding end element has been read. After invocation the end element has just been read (and would be returned on relevant state calls).

skipPreamble

fun XmlReader.skipPreamble()

Skil the preamble events in the stream reader

toCharArrayWriter

fun XmlReader.toCharArrayWriter(): CharArrayWriter

Write all the remaining content of the reader to a CharArrayWriter. Note that this likely fails if the reader is not at the start (as the writer would fail due to an invalid XML document).

toEvent

fun XmlReader.toEvent(): XmlEvent

Create an XmlEvent for the current event in an XmlReader.

writeCurrent

fun XmlReader.writeCurrent(writer: XmlWriter)

Write the current event to the writer. This will not move the reader.