Class Document

文档

XML 文档的表示形式。

方法

方法返回类型简介
addContent(content)Document将指定节点附加到文档末尾。
addContent(index, content)Document在文档的所有直接子节点中,将给定节点插入给定索引。
cloneContent()Content[]为文档的所有直接子节点创建未附加的副本。
detachRootElement()Element分离并返回文档的根 Element 节点。
getAllContent()Content[]获取文档的直接子级的所有节点。
getContent(index)Content从文档的所有直接子节点中获取给定索引对应的节点。
getContentSize()Integer获取文档的直接子节点的数量。
getDescendants()Content[]获取文档的直接或间接子节点,按文档中显示的顺序。
getDocType()DocType获取文档的 DocType 声明。
getRootElement()Element获取文档的根 Element 节点。
hasRootElement()Boolean确定文档是否具有根 Element 节点。
removeContent()Content[]移除文档的所有直接子节点。
removeContent(content)Boolean如果给定节点是文档的直接子节点,则移除该节点。
removeContent(index)Content从文档的所有直接子节点中移除给定索引对应的节点。
setDocType(docType)Document设置文档的 DocType 声明。
setRootElement(element)Document设置文档的根 Element 节点。

详细文档

addContent(content)

将指定节点附加到文档末尾。content 参数可以是 Content 对象,也可以是与 ContentType 中列出的类型对应的任何节点对象。不过,请注意,文档只能有一个子 Element 节点,该节点隐式为根 Element 节点。

参数

名称类型说明
contentContent要附加的节点

返回

Document - 文档,用于链式调用


addContent(index, content)

在文档的所有直接子节点中,将给定节点插入给定索引。content 参数可以是 Content 对象,也可以是与 ContentType 中列出的类型对应的任何节点对象。不过,请注意,文档只能有一个子 Element 节点,该节点隐式地是根 Element 节点。

参数

名称类型说明
indexInteger在文档的所有直接子节点中插入节点的位置索引
contentContent要插入的节点

返回

Document - 文档,用于链式调用


cloneContent()

为文档的所有直接子节点创建未附加的副本。

返回

Content[] - 文档的直接子项的所有节点的未附加副本的数组


detachRootElement()

分离并返回文档的根 Element 节点。如果文档没有根 Element 节点,此方法会返回 null

返回

Element - 分离的 Element 节点,如果文档没有根 Element 节点,则为 null


getAllContent()

获取文档的直接子级的所有节点。

返回

Content[] - 文档的所有直接子节点的数组


getContent(index)

从文档的所有直接子节点中获取给定索引对应的节点。如果指定索引处没有节点,则此方法会返回 null

参数

名称类型说明
indexInteger在文档的所有直接子节点中,节点的编号

返回

Content - 节点;如果给定索引没有节点,则为 null


getContentSize()

获取文档的直接子节点的数量。

返回

Integer - 文档的直接子节点的数量


getDescendants()

获取文档的直接或间接子节点,按文档中显示的顺序。

返回

Content[] - 文档的直接或间接子节点的数组


getDocType()

获取文档的 DocType 声明。如果文档没有 DocumentType 节点,此方法会返回 null

返回

DocType - DocumentType 节点,如果文档没有 DocumentType 节点,则为 null


getRootElement()

获取文档的根 Element 节点。如果文档没有根 Element 节点,此方法会返回 null

返回

Element - 根 Element 节点,如果文档没有根 Element 节点,则为 null


hasRootElement()

确定文档是否具有根 Element 节点。

返回

Boolean - 如果文档具有根 Element 节点,则为 true;否则为 false


removeContent()

移除文档的所有直接子节点。

返回

Content[] - 一个数组,其中包含在被移除之前是文档的直接子项的所有节点


removeContent(content)

如果给定节点是文档的直接子节点,则移除该节点。content 参数可以是 Content 对象,也可以是与 ContentType 中列出的类型对应的任何节点对象。

参数

名称类型说明
contentContent要移除的节点

返回

Boolean - 如果节点是直接子节点且已被移除,则为 true;否则为 false


removeContent(index)

从文档的所有直接子节点中移除给定索引对应的节点。如果指定索引处没有节点,则此方法会返回 null

参数

名称类型说明
indexInteger在文档的所有直接子节点中,节点的编号

返回

Content - 被移除的节点;如果给定索引处没有节点,则返回 null


setDocType(docType)

设置文档的 DocType 声明。如果文档已有其他 DocType 节点,此方法会覆盖旧节点。如果文档已包含要设置的 DocType 节点,此方法会抛出异常。

参数

名称类型说明
docTypeDocType要设置的 DocumentType

返回

Document - 文档,用于链式调用


setRootElement(element)

设置文档的根 Element 节点。如果文档已具有根 Element 节点,此方法会覆盖旧节点。

参数

名称类型说明
elementElement要设置的根 Element 节点

返回

Document - 文档,用于链式调用