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

extLocationInfo

open override val extLocationInfo: XmlReader.LocationInfo?

hasPeekItems

abstract override val hasPeekItems: Boolean

Are we peeking (is the underlying buffer ahead)

isStarted

open override val isStarted: Boolean

localName

open override val localName: String

name

open val name: QName

namespaceContext

open override val namespaceContext: IterableNamespaceContext

The current namespace context

namespaceDecls

open override val namespaceDecls: List<Namespace>

namespaceURI

open override val namespaceURI: String

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

qname

val XmlReader.qname: QName

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

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

allConsecutiveTextContent

fun XmlPeekingReader.allConsecutiveTextContent(): String

Consume all text and non-content (comment/processing instruction) to get an uninterrupted text sequence. This will skip over comments but not ignorable whitespace that starts the string, but not tags. Any tags encountered will lead to a return of this function. 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.

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

open override fun close()

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

getAttributeName

open fun getAttributeName(index: Int): QName

getAttributeNamespace

open override fun getAttributeNamespace(index: Int): String

getAttributePrefix

open override fun getAttributePrefix(index: Int): String

getAttributeValue

open override fun getAttributeValue(index: Int): String

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

open fun getAttributeValue(name: QName): String?

getNamespacePrefix

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

getNamespaceURI

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

hasNext

operator override fun hasNext(): Boolean

isCharacters

open fun isCharacters(): Boolean

Is the currrent element character content

isElement

fun XmlReader.isElement(elementname: QName): Boolean

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 fun isEndElement(): Boolean

isIgnorable

fun XmlReader.isIgnorable(): Boolean

isPrefixDeclaredInElement

fun XmlReader.isPrefixDeclaredInElement(prefix: String): Boolean

isStartElement

open fun isStartElement(): Boolean

Is the current element a start element

isWhitespace

open fun isWhitespace(): Boolean

isXml

fun XmlReader.isXml(): Boolean

open operator override fun next(): EventType

nextEvent

fun nextEvent(): XmlEvent

nextTag

open override fun nextTag(): EventType

Get the next tag. This must call next, not use the underlying stream.

nextTagEvent

fun nextTagEvent(): XmlEvent

peek

fun peek(): XmlEvent?

Try to peek the next event. Unlike peekFirst this function will progress the underlying stream if needed.

peekNextEvent

open override fun peekNextEvent(): EventType?

Peek the next event only (this doesn't give access to the peeked information.

pushBackCurrent

abstract override fun pushBackCurrent()

Put the current element in the peek buffer. This is basically a very limited pushback

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 fun require(type: EventType, name: QName?)

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

siblingsToFragment

actual fun XmlReader.siblingsToFragment(): CompactFragment

expect fun XmlReader.siblingsToFragment(): CompactFragment

actual fun XmlReader.siblingsToFragment(): CompactFragment

Read the current element (and content) and all its siblings into a 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

toEvent

fun XmlReader.toEvent(): XmlEvent

writeCurrent

fun XmlReader.writeCurrent(writer: XmlWriter)

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