Xml

no package

Available on all platforms

Cross-platform Xml API.

See:

https://haxe.org/manual/std-Xml.html

Variables

@:isVar nodeName:String

Returns the node name of an Element.

read only 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.

@:isVar nodeValue:String

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

read only parent:Xml

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

Methods

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.

attributes ():Iterator<String>

Returns an Iterator on all the attribute names.

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.

elementsNamed (name:String):Iterator<Xml>

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

exists (att:String):Bool

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

inline firstChild ():Xml

Returns the first child node.

firstElement ():Xml

Returns the first child node which is an Element.

get (att:String):String

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

insertChild (x:Xml, pos:Int):Void

Inserts a child at the given position among the other childs. 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 new 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.

inline iterator ():Iterator<Xml>

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

remove (att:String):Void

Removes an attribute for an Element node. Attributes are case-sensitive.

removeChild (x:Xml):Bool

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

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

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

inline toString ():String

Returns a String representation of the Xml node.

Static variables

@:value(XmlType.CData) static read only CData:XmlType = XmlType.CData

XML character data type.

@:value(XmlType.Comment) static read only Comment:XmlType = XmlType.Comment

XML comment type.

@:value(XmlType.DocType) static read only DocType:XmlType = XmlType.DocType

XML doctype element type.

@:value(XmlType.Document) static read only Document:XmlType = XmlType.Document

XML document type.

@:value(XmlType.Element) static read only Element:XmlType = XmlType.Element

XML element type.

@:value(XmlType.PCData) static read only PCData:XmlType = XmlType.PCData

XML parsed character data type.

@:value(XmlType.ProcessingInstruction) static read only ProcessingInstruction:XmlType = XmlType.ProcessingInstruction

XML processing instruction type.

Static methods

static createCData (data:String):Xml

Creates a node of the given type.

static createComment (data:String):Xml

Creates a node of the given type.

static createDocType (data:String):Xml

Creates a node of the given type.

static createDocument ():Xml

Creates a node of the given type.

static createElement (name:String):Xml

Creates a node of the given type.

static createPCData (data:String):Xml

Creates a node of the given type.

static createProcessingInstruction (data:String):Xml

Creates a node of the given type.

static parse (str:String):Xml

Parses the String into an Xml document.