
HarmonyOS API:@ohos.xml (xml解析与生成)
版本:v3.1 Beta
@ohos.xml (xml解析与生成)
更新时间: 2023-02-17 09:19
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
XmlSerializer
constructor
constructor(buffer: ArrayBuffer | DataView, encoding?: string)
XmlSerializer的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
buffer | ArrayBuffer | DataView | 是 | 用于接收写入xml信息的ArrayBuffer或DataView内存。 |
encoding | string | 否 | 编码格式。 |
示例:
setAttributes
setAttributes(name: string, value: string): void
设置Attributes方法。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 属性的key值。 |
value | string | 是 | 属性的value值。 |
示例:
addEmptyElement
addEmptyElement(name: string): void
写入一个空元素。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 该空元素的元素名。 |
示例:
setDeclaration
setDeclaration(): void
设置Declaration方法。
系统能力: SystemCapability.Utils.Lang
示例:
startElement
startElement(name: string): void
根据给定名称写入元素开始标记。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 当前元素的元素名。 |
示例:
endElement
endElement(): void
写入元素结束标记。
系统能力: SystemCapability.Utils.Lang
示例:
setNamespace
setNamespace(prefix: string, namespace: string): void
写入当前元素标记的命名空间。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
prefix | string | 是 | 当前元素及其子元素的前缀。 |
namespace | string | 是 | 当前元素及其子元素的命名空间。 |
示例:
setComment
setComment(text: string): void
写入comment属性。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | 当前元素的注释内容。 |
示例:
setCDATA
setCDATA(text: string): void
写入CDATA属性。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | CDATA属性的内容。 |
示例:
setText
setText(text: string): void
设置Text方法。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | text属性的内容。 |
示例:
setDocType
setDocType(text: string): void
写入DocType属性。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | DocType属性的内容。 |
示例:
XmlPullParser
XmlPullParser
constructor(buffer: ArrayBuffer | DataView, encoding?: string)
创建并返回一个XmlPullParser对象,该XmlPullParser对象传参两个, 第一参数是ArrayBuffer或DataView类型的一段内存,第二个参数为文件格式(默认为UTF-8)
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
buffer | ArrayBuffer | DataView | 是 | 含有xml文本信息的ArrayBuffer或者DataView。 |
encoding | string | 否 | 编码格式(仅支持utf-8)。 |
示例:
parse
parse(option: ParseOptions): void
该接口用于解析xml。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
option | 是 | 用户控制以及获取解析信息的选项。 |
示例:
ParseOptions
xml解析选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.Utils.Lang
名称 | 类型 | 必填 | 说明 |
supportDoctype | boolean | 否 | 是否忽略Doctype , 默认false。 |
ignoreNameSpace | boolean | 否 | 是否忽略NameSpace,默认false。 |
tagValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取tagValue回调函数。 |
attributeValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取attributeValue回调函数。 |
tokenValueCallbackFunction | (eventType: EventType, value: ParseInfo) => boolean | 否 | 获取tokenValue回调函数。 |
ParseInfo
当前xml解析信息。
getColumnNumber
getColumnNumber(): number
获取当前列号,从1开始。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
number | 返回当前列号。 |
示例:
getDepth
getDepth(): number
获取元素的当前深度。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
number | 返回元素的当前深度。 |
示例:
getLineNumber
getLineNumber(): number
获取当前行号,从1开始。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
number | 返回当前行号。 |
示例:
getName
getName(): string
获取当前元素名称。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回当前元素名称。 |
示例:
getNamespace
getNamespace(): string
获取当前元素的命名空间。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回当前元素的命名空间。 |
示例:
getPrefix
getPrefix(): string
获取当前元素前缀。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回当前元素前缀。 |
示例:
getText
getText(): string
获取当前事件的文本内容。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回当前事件的文本内容。 |
示例:
isEmptyElementTag
isEmptyElementTag(): boolean
判断当前元素是否为空元素。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
boolean | 返回true,当前元素为空元素。 |
示例:
isWhitespace
isWhitespace(): boolean
判断当前文本事件是否仅包含空格字符。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
boolean | 返回true,当前文本事件仅包含空格字符。 |
示例:
getAttributeCount
getAttributeCount(): number
获取当前开始标记的属性数。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
number | 当前开始标记的属性数。 |
示例:
EventType
事件枚举。
系统能力: SystemCapability.Utils.Lang
名称 | 值 | 说明 |
START_DOCUMENT | 0 | 启动文件事件。 |
END_DOCUMENT | 1 | 结束文件事件。 |
START_TAG | 2 | 启动标签事件。 |
END_TAG | 3 | 结束标签事件。 |
TEXT | 4 | 文本事件。 |
CDSECT | 5 | CDATA事件。 |
COMMENT | 6 | XML注释事件。 |
DOCDECL | 7 | XML文档类型声明事件。 |
INSTRUCTION | 8 | XML处理指令声明事件。 |
ENTITY_REFERENCE | 9 | 实体引用事件。 |
WHITESPACE | 10 | 空白事件。 |
