XML Parsing and Generation

NOTE The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import xml from '@ohos.xml';

System Capabilities

SystemCapability.Utils.Lang

XmlSerializer

constructor

constructor(buffer: ArrayBuffer | DataView, encoding?: string)

A constructor used to create an XmlSerializer instance.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);

setAttributes

setAttributes(name: string, value: string): void

Sets an attribute.

Parameters

Example

var thatSer = new xml.XmlSerializer(bufView);
thatSer.setAttributes("importance", "high");  

addEmptyElement

addEmptyElement(name: string): void

Adds an empty element.

Parameters

Example

var thatSer = new xml.XmlSerializer(bufView);
thatSer.addEmptyElement("b"); // => <b/>

setDeclaration

setDeclaration(): void

Sets a declaration.

Example

var thatSer = new xml.XmlSerializer(bufView);
thatSer.setDeclaration() // => <?xml version="1.0" encoding="utf-8"?>;

startElement

startElement(name: string): void

Writes the start tag based on the given element name.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("notel");
thatSer.endElement();// => '<notel/>';

endElement

endElement(): void

Writes the end tag of the element.

Example

var thatSer = new xml.XmlSerializer(bufView);
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("table");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy");
endElement(); // => <h:table importance="high" xmlns:h="http://www.w3.org/TR/html4/">Happy</h:table>

setNamespace

setNamespace(prefix: string, namespace: string): void

Sets the namespace for an element tag.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDeclaration();
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("note");
thatSer.endElement();// = >'<?xml version="1.0" encoding="utf-8"?>\r\n<h:note xmlns:h="http://www.w3.org/TR/html4/"/>';

setComment

setComment(text: string): void

Sets the comment.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setComment("Hi!");
thatSer.endElement(); // => '<note>\r\n  <!--Hi!-->\r\n</note>';

setCDATA

setCDATA(text: string): void

Sets CDATA attributes.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1028);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setCDATA('root SYSTEM') // => '<![CDATA[root SYSTEM]]>';

setText

setText(text: string): void

Sets Text.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy1");
thatSer.endElement(); // => '<note importance="high">Happy1</note>';

setDocType

setDocType(text: string): void

Sets DocType.

Parameters

Example

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDocType('root SYSTEM'); // => '<!DOCTYPE root SYSTEM>';

XmlPullParser

XmlPullParser

constructor(buffer: ArrayBuffer | DataView, encoding?: string)

Creates and returns an XmlPullParser object. The XmlPullParser object passes two parameters. The first parameter is the memory of the ArrayBuffer or DataView type, and the second parameter is the file format (UTF-8 by default).

Parameters

Example

var strXml =
            '<?xml version="1.0" encoding="utf-8"?>' +
            '<note importance="high" logged="true">' +
            '    <title>Happy</title>' +
            '    <todo>Work</todo>' +
            '    <todo>Play</todo>' +
            '</note>';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
    bufView[i] = strXml.charCodeAt(i);// Set the ArrayBuffer mode.
}
var that = new xml.XmlPullParser(arrayBuffer);

parse

parse(option: ParseOptions): void

Parses XML information.

Parameters

Example

var strXml =
            '<?xml version="1.0" encoding="utf-8"?>' +
            '<note importance="high" logged="true">' +
            '    <title>Happy</title>' +
            '    <todo>Work</todo>' +
            '    <todo>Play</todo>' +
            '</note>';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
    bufView[i] = strXml.charCodeAt(i);
}
var that = new xml.XmlPullParser(arrayBuffer);
var arrTag = {};
arrTag[0] = '132';
var i = 1;
function func(key, value){
    arrTag[i] = 'key:'+key+' value:'+ value.getDepth();
    i++;
    return true;
}
var options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func}
that.parse(options);

ParseOptions

Defines the XML parsing options.

ParseInfo

Provides APIs to manage the parsed XML information.

getColumnNumber

getColumnNumber(): number

Obtains the column line number, which starts from 1.

Return value

getDepth

getDepth(): number

Obtains the depth of this element.

Return value

getLineNumber

getLineNumber(): number

Obtains the current line number, starting from 1.

Return value

getName

getName(): string

Obtains the name of this element.

Return value

getNamespace

getNamespace(): string

Obtains the namespace of this element.

Return value

getPrefix

getPrefix(): string

Obtains the prefix of this element.

Return value

getText

getText(): string

Obtains the text of the current event.

Return value

isEmptyElementTag

isEmptyElementTag(): boolean

Checks whether the current element is empty.

Return value

isWhitespace

isWhitespace(): boolean

Checks whether the current text event contains only whitespace characters.

Return value

getAttributeCount

getAttributeCount(): number

Obtains the number of attributes for the current start tag.

Return value

EventType

Enumerates the events.