Class Document

文档

XML 文档的表示形式。

方法

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

详细文档

addContent(content)

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

参数

名称	类型	说明
content	Content	要附加的节点。

返回

Document - 用于链式调用的文档。

---

addContent(index, content)

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

参数

名称	类型	说明
index	Integer	要在文档的所有直属子节点中插入节点的索引。
content	Content	要插入的节点。

返回

Document - 用于链式调用的文档。

---

cloneContent()

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

返回

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

---

detachRootElement()

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

返回

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

---

getAllContent()

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

返回

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

---

getContent(index)

获取文档的所有直接子节点中位于指定索引处的节点。如果指定索引处没有节点，此方法会返回 null。

参数

名称	类型	说明
index	Integer	相应节点在文档的所有直属子节点中的索引。

返回

Content|null - 相应节点；如果给定索引处没有节点，则为 null。

---

getContentSize()

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

返回

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

---

getDescendants()

按节点在文档中出现的顺序获取文档的所有直接或间接子节点。

返回

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

---

getDocType()

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

返回

DocType|null - DocumentType 节点，如果文档没有 DocumentType 节点，则为 null。

---

getRootElement()

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

返回

Element|null - 根 Element 节点，如果文档没有根 Element 节点，则为 null。

---

hasRootElement()

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

返回

Boolean - 如果文档具有根 Element 节点，则为 true；否则为 false。

---

removeContent()

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

返回

Content[] - 移除之前文档的所有直接子节点的数组。

---

removeContent(content)

移除指定节点（如果该节点是文档的直接子节点）。content 实参可以是 Content 对象，也可以是与 ContentType 中列出的类型对应的任何节点对象。

参数

名称	类型	说明
content	Content	要移除的节点。

返回

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

---

removeContent(index)

移除文档的所有直属子节点中位于指定索引处的节点。如果指定索引处没有节点，此方法会返回 null。

参数

名称	类型	说明
index	Integer	相应节点在文档的所有直属子节点中的索引。

返回

Content|null - 已移除的节点；如果给定索引处没有节点，则返回 null。

---

setDocType(docType)

设置文档的 DocType 声明。如果文档已具有不同的 DocType 节点，此方法会覆盖旧节点。如果文档已包含要设置的相同 DocType 节点，此方法会抛出异常。

参数

名称	类型	说明
docType	DocType	要设置的 DocumentType。

返回

Document - 用于链式调用的文档。

---

setRootElement(element)

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

参数

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

返回

Document - 用于链式调用的文档。