Fantom

 

class

xml::XParser

sys::Obj
  xml::XParser

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.

See docLib::Xml

Slots

closeSource

Bool close()

Close the underlying input stream. Return true if the stream was closed successfully or false if the stream was closed abnormally.

colSource

readonly Int col := 1

Current one based column number.

depthSource

readonly Int depth := -1

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.

docSource

readonly XDoc doc := XDoc()

Get the root document node.

elemSource

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.

elemAtSource

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.

lineSource

readonly Int line := 1

Current one based line number.

makeSource

new make(InStream in)

Construct input stream to read.

nextSource

XNodeType? next()

Advance the parser to the next node and return the node type. Return the current node type:

nodeTypeSource

readonly XNodeType? nodeType

Get the current node type constant which is always the result of the last call to next. Node type will be:

parseDocSource

XDoc parseDoc(Bool close := true)

Parse the entire document into memory as a tree of XElems and optionally close the underlying input stream.

parseElemSource

XElem parseElem(Bool close := true)

Parse the current element entirely into memory as a tree of XElems and optionally close the underlying input stream.

piSource

XPi? pi()

if the current node type is pi return the XPi instance otherwise return null.

skipSource

Void skip(Int toDepth := this.depth)

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.

textSource

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.