Jive

API documentation

class Xml

Class Fields

static var CData:XmlType

static var Comment:XmlType

static var DocType:XmlType

static var Document:XmlType

static var Element:XmlType

static var PCData:XmlType

static var ProcessingInstruction:XmlType

static function createCData(data:String): Xml

Creates a node of the given type.

static function createComment(data:String): Xml

Creates a node of the given type.

static function createDocType(data:String): Xml

Creates a node of the given type.

static function createDocument(): Xml

Creates a node of the given type.

static function createElement(name:String): Xml

Creates a node of the given type.

static function createPCData(data:String): Xml

Creates a node of the given type.

static function createProcessingInstruction(data:String): Xml

Creates a node of the given type.

static function parse(str:String): Xml

Instance Fields

var nodeName:String

Returns the node name of an Element.

var nodeType:XmlType

Returns the type of the Xml Node. This should be used before accessing other functions since some might raise an exception if the node type is not correct.

var nodeValue:String

Returns the node value. Only works if the Xml node is not an Element or a Document.

var parent:Xml

Returns the parent object in the Xml hierarchy. The parent can be [null], an Element or a Document.

function addChild(x:Xml): Void

Adds a child node to the Document or Element. A child node can only be inside one given parent node, which is indicated by the [parent] property. If the child is already inside this Document or Element, it will be moved to the last position among the Document or Element's children. If the child node was previously inside a different node, it will be moved to this Document or Element.

function attributes(): Iterator<String>

Returns an [Iterator] on all the attribute names.

function elements(): Iterator<Xml>

Returns an iterator of all child nodes which are Elements. Only works if the current node is an Element or a Document.

function exists(att:String): Bool

Tells if the Element node has a given attribute. Attributes are case-sensitive.

function firstElement(): Xml

Returns the first child node which is an Element.

function get(att:String): String

Get the given attribute of an Element node. Returns [null] if not found. Attributes are case-sensitive.

function removeChild(x:Xml): Bool

Removes a child from the Document or Element. Returns true if the child was successfuly removed.

function set(att:String, value:String): Void

Set the given attribute value for an Element node. Attributes are case-sensitive.