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 - 用于串联的文档