serde-xml/aws.smithy.kotlin.runtime.serde.xml/XmlTagReader

XmlTagReader

class XmlTagReader(val tag: XmlToken.BeginElement, reader: XmlStreamReader)

An XmlStreamReader scoped to reading a single XML element tag XmlTagReader provides a "tag" scoped view into an XML document. Methods return null when the current tag has been exhausted.

Constructors

XmlTagReader

constructor(tag: XmlToken.BeginElement, reader: XmlStreamReader)

Properties

tag

val tag: XmlToken.BeginElement

tagName

val tagName: String

Get the fully qualified tag name of tag

Functions

drop

fun drop()

Exhaust this XmlTagReader to completion. This should always be invoked to maintain deserialization state.

nextHasValue

fun nextHasValue(): Boolean

Check if the next token has a value, returns false if XmlToken.EndElement would be returned.

nextTag

fun nextTag(): XmlTagReader?

Return an XmlTagReader for the next XmlToken.BeginElement. The returned reader is only valid until nextTag is called or drop is invoked on it, whichever comes first.

nextToken

fun nextToken(): XmlToken?

Return the next actionable token or null if stream is exhausted.

Inherited functions

data

fun XmlTagReader.data(): String

Unwrap the next token as XmlToken.Text and return its value or throw a DeserializationException

tryData

fun XmlTagReader.tryData(): <Error class: unknown class><String>

Attempt to get the text token as XmlToken.Text and return a result containing its' value on success or the exception thrown on failure.