XParser
@Js
class XParser : Obj
XParser is a simple, lightweight XML parser. It may be used as a pull parser by iterating through the element and text sections of an XML stream or it may be used to read an entire XML tree into memory as XElems.
Construct input stream to read
Current one based column number
Get the depth of the current element with the document
Current one based line number
Get the root document node
Get the current node type constant which is always the result of the last call to next
Get the current element if nodeType is elemStart or elemEnd
Advance the parser to the next node and return the node type
Parse the current element entirely into memory as a tree of XElems and optionally close the underlying input stream
Get the element at the specified depth
Parse the entire document into memory as a tree of XElems and optionally close the underlying input stream
if the current node type is pi return the XPi instance otherwise return null
Skip parses all the content until reaching the end tag of the specified depth
If the current type is text the XText instance used to store the character data
Close the underlying input stream
Bool close()
Close the underlying input stream. Return true if the stream was closed successfully or false if the stream was closed abnormally.
Int : col
Current one based column number.
Int : depth
Get the depth of the current element with the document. A depth of zero indicates the root element. A depth of -1 indicates a position before or after the root element.
XDoc : doc
Get the root document node.
XElem? elem()
Get the current element if nodeType is elemStart or elemEnd. If nodeType is text or pi then this is the parent element. After elemEnd this XElem instance is no longer valid and will be reused for further processing. If depth is -1 return null.
XElem elemAt(Int depth)
Get the element at the specified depth. Depth must be between 0 and depth inclusively. Calling elemAt(0) will return the root element and elemAt(depth) returns the current element. If depth is invalid IndexErr is thrown.
Int : line
Current one based line number.
new make(InStream in)
Construct input stream to read.
XNodeType? next()
Advance the parser to the next node and return the node type. Return the current node type:
- XNodeType.elemStart
- XNodeType.elemEnd
- XNodeType.text
- XNodeType.pi
- null indicates end of stream Also see nodeType.
XNodeType? : nodeType
Get the current node type constant which is always the result of the last call to next. Node type will be:
- XNodeType.elemStart
- XNodeType.elemEnd
- XNodeType.text
- XNodeType.pi
- null indicates end of stream
XDoc parseDoc(Bool close)
Parse the entire document into memory as a tree of XElems and optionally close the underlying input stream.
XElem parseElem(Bool close)
Parse the current element entirely into memory as a tree of XElems and optionally close the underlying input stream.
XPi? pi()
if the current node type is pi return the XPi instance otherwise return null.
Void skip(Int toDepth)
Skip parses all the content until reaching the end tag of the specified depth. When this method returns, the next call to next will return the node immediately following the end tag.
XText? text()
If the current type is text the XText instance used to store the character data. After a call to next this XText instance is no longer valid and will be reused for further processing. If the current type is not text then return null.