Xml

Xml (Class)

Cross-platform Xml API.

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

Static Members

Element: XmlType

XML element type.

PCData: XmlType

XML parsed character data type.

CData: XmlType

XML character data type.

Comment: XmlType

XML comment type.

DocType: XmlType

XML doctype element type.

ProcessingInstruction: XmlType

XML processing instruction type.

Document: XmlType

XML document type.

parse(str: String): Xml

Parses the String into an Xml document.

Name Type
str String
Returns
Xml
createElement(name: String): Xml

Creates a node of the given type.

Name Type
name String
Returns
Xml
createPCData(data: String): Xml

Creates a node of the given type.

Name Type
data String
Returns
Xml
createCData(data: String): Xml

Creates a node of the given type.

Name Type
data String
Returns
Xml
createComment(data: String): Xml

Creates a node of the given type.

Name Type
data String
Returns
Xml
createDocType(data: String): Xml

Creates a node of the given type.

Name Type
data String
Returns
Xml
createProcessingInstruction(data: String): Xml

Creates a node of the given type.

Name Type
data String
Returns
Xml
createDocument(): Xml

Creates a node of the given type.

Returns
Xml

Instance Members

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.

nodeName: String

Returns the node name of an Element.

nodeValue: String

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

parent: Xml

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

get(att: String): String

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

Name Type
att String
Returns
String
set(att: String, value: String): Void

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

Name Type
att String
value String
exists(att: String): Bool

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

Name Type
att String
Returns
Bool
attributes(): Iterator

Returns an Iterator on all the attribute names.

Returns
Iterator
iterator(): Iterator

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

Returns
Iterator
elements(): Iterator

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

Returns
Iterator
elementsNamed(name: String): Iterator

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.

Name Type
name String
Returns
Iterator
firstElement(): Xml

Returns the first child node which is an Element.

Returns
Xml
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.

Name Type
x Xml
removeChild(x: Xml): Bool

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

Name Type
x Xml
Returns
Bool
toString(): String

Returns a String representation of the Xml node.

Returns
String

Private Members

children: Array<Xml>
attributeMap: Map
ensureElementType(): Void
new(nodeType: XmlType): Void
Name Type
nodeType XmlType

Metadata

Name Parameters
:hxGen -