core/nl.adaptivity.xmlutil/XmlReader

XmlReader

interface XmlReader : Closeable, Iterator<EventType> (source)

Interface that is the entry point to the xml parsing. All implementations implement this interface, generally by delegating to a platform specific parser.

Inheritors

DomReader

XmlBufferReader

XmlBufferedReaderBase

XmlDelegatingReader

PlatformXmlReader

KtXmlReader

XMLFragmentStreamReaderJava

Properties

attributeCount

abstract val attributeCount: Int

attributeIndices

val XmlReader.attributeIndices: IntRange

attributes

val XmlReader.attributes: Array<out XmlEvent.Attribute>

depth

abstract val depth: Int

encoding

abstract val encoding: String?

eventType

abstract val eventType: EventType

isStarted

abstract val isStarted: Boolean

localName

abstract val localName: String

locationInfo

abstract val locationInfo: String?

Get some information on the current location in the file. This is implementation dependent.

name

open val name: QName

namespaceContext

abstract val namespaceContext: IterableNamespaceContext

The current namespace context

namespaceDecls

abstract val namespaceDecls: List<Namespace>

namespaceURI

abstract val namespaceURI: String

piData

abstract val piData: String

Data for processing instructions.

piTarget

abstract val piTarget: String

Target for processing instructions.

prefix

abstract val prefix: String

qname

val XmlReader.qname: QName

standalone

abstract val standalone: Boolean?

text

abstract val text: String

version

abstract val version: String?

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

abstract 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

abstract fun getAttributeLocalName(index: Int): String

getAttributeName

open fun getAttributeName(index: Int): QName

getAttributeNamespace

abstract fun getAttributeNamespace(index: Int): String

getAttributePrefix

abstract fun getAttributePrefix(index: Int): String

getAttributeValue

abstract fun getAttributeValue(index: Int): String

open fun getAttributeValue(name: QName): String?

abstract fun getAttributeValue(nsUri: String?, localName: String): String?

getNamespacePrefix

abstract fun getNamespacePrefix(namespaceUri: String): String?

getNamespaceURI

abstract fun getNamespaceURI(prefix: String): String?

hasNext

abstract 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

abstract operator override fun next(): EventType

nextTag

open fun nextTag(): EventType

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

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

expect fun XmlReader.siblingsToFragment(): CompactFragment

actual fun XmlReader.siblingsToFragment(): CompactFragment

Read the current element (and content) and all its siblings into a fragment.

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

toCharArrayWriter

fun XmlReader.toCharArrayWriter(): CharArrayWriter

toEvent

fun XmlReader.toEvent(): XmlEvent

writeCurrent

fun XmlReader.writeCurrent(writer: XmlWriter)

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