类
class XmlAttr
public class XmlAttr <: ToString {
public init(name: String, content: String)
}
功能:此类存储 XML 元素节点属性,并提供查询其内容的函数。
部分接口提供了有限的检查功能,例如节点名称为空,首字母为 '-' 、 '.' 、 '[0-9]' 等。
说明:
如需使用 XmlAttr 构造 XML 文档,请注意符合 XML 规范,具体规范请查阅 W3C 官网。
prop content
public mut prop content: String
功能:获取或设置属性值。
类型:String
prop name
public mut prop name: String
功能:获取或设置属性名称。
类型:String
异常:
- XmlException - 当属性名称为空,或首字母为 '-' 、 '.' 、 '[0-9]' 时,抛出异常。
init(String, String)
public init(name: String, content: String)
功能:创建一个 XmlAttr 对象。
参数:
异常:
- XmlException - 当属性名称为空,或首字母为 '-' 、 '.' 、 '[0-9]' 时,抛出异常。
func toString()
public func toString(): String
功能:将 XmlAttr 转换成字符串。
返回值:
class XmlElement
public class XmlElement <: ToString {
public init(name: String, content: String)
}
功能:此类存储 XML 元素节点,并提供查询其内容的函数。
部分接口提供了有限的检查功能,例如节点名称为空,首字母为 '-' 、 '.' 、 '[0-9]',属性名称必须保证唯一等。
说明:
如需使用 XmlELement 构造 XML 文档,请注意符合 XML 规范,具体规范请查阅 W3C 官网。
prop attributes
public mut prop attributes: ArrayList<XmlAttr>
功能:获取节点的属性,返回节点属性的深拷贝,设置节点的属性。
异常:
- XmlException - 当设置节点属性时,如果传入的属性列表中有重复字段,抛出异常。
prop attributesNum
public prop attributesNum: Int64
功能:获取节点的属性个数。
类型:Int64
prop childrenElements
public mut prop childrenElements: ArrayList<XmlElement>
功能:获取或设置节点的所有子节点。
类型:ArrayList<XmlElement>
prop childrenNum
public prop childrenNum: Int64
功能:获取节点的子节点个数。
类型:Int64
prop content
public mut prop content: String
功能:获取或设置节点文本内容。
类型:String
prop isClosed
public prop isClosed: Bool
功能:判断节点是否闭合。
类型:Bool
prop name
public mut prop name: String
功能:获取或设置节点名称。
类型:String
异常:
- XmlException - 当设置节点名称为空,或首字母为 '-' 、 '.' 、 '[0-9]' 时,抛出异常。
init(String, String)
public init(name: String, content: String)
功能:创建一个 XmlElement 对象。
参数:
异常:
- XmlException - 当设置节点名称为空,或首字母为 '-' 、 '.' 、 '[0-9]' 时,抛出异常。
func toString()
public func toString(): String
功能:返回 XML 字符串,该字符串会在一行显示,其中的实体引用将会被解析,例如: '<
' 将替换成 '<'。
返回值:
- String - 解析得到的字符串。
func toXmlString()
public func toXmlString(): String
功能:返回格式化后的 XML 字符串,该字符串会以 XML 的格式体现,其中的实体引用将会被解析,例如: '<
' 将替换成 '<'。
返回值:
- String - 解析并且格式化后的字符串。
class XmlParser
public class XmlParser {
public init()
public init(handler: SaxHandler)
}
功能:此类提供 XML 解析功能。
目前支持两种模式:文档对象模型(DOM)模式和 XML 简单 API(SAX)模式,暂不支持外部实体功能,以及 <? ?> 形式的指令声明。
支持 5 个内置符号的解析,如下表所示:
| 符号 | 字符 |
| --- | --- |
| <
| <
, <
, <
|
| >
| >
, >
, >
|
| &
| &
, &
, &
|
| '
| '
, '
, '
|
| "
| "
, "
, "
|
init()
public init()
功能:创建 XML 文档对象模型(DOM)模式解析器。
异常:
- XmlException - 当初始化失败时,抛出异常。
init(SaxHandler)
public init(handler: SaxHandler)
功能:创建 XML 简单 API(SAX)模式解析器。
参数:
- handler: SaxHandler - 实现了 SaxHandler 的一组回调函数。
异常:
- XmlException - 当初始化失败时,抛出异常。
func parse(String)
public func parse(str: String): Option<XmlElement>
功能:解析字符串类型的 XML 文本。
参数:
返回值:
- Option<XmlElement> - DOM 模式下如果解析成功则返回 Option<XmlElement>.Some(element),失败则返回 Option<XmlElement>.None;SAX 模式下返回 Option<XmlElement>.None。
异常:
- XmlException - 当内存分配失败,或解析文本出错,或存在空指针时,抛出异常。
- IllegalArgumentException - 当 XML 文本中包含字符串结束符时,抛出异常。