A representation of an XML document.
Methods
Method | Return type | Brief description |
---|---|---|
addContent(content) | Document | Appends the given node to the end of the document. |
addContent(index, content) | Document | Inserts the given node at the given index among all nodes that are immediate children of the document. |
cloneContent() | Content[] | Creates unattached copies of all nodes that are immediate children of the document. |
detachRootElement() | Element | Detaches and returns the document's root Element node. |
getAllContent() | Content[] | Gets all nodes that are immediate children of the document. |
getContent(index) | Content | Gets the node at the given index among all nodes that are immediate children of the document. |
getContentSize() | Integer | Gets the number of nodes that are immediate children of the document. |
getDescendants() | Content[] | Gets all nodes that are direct or indirect children of the document, in the order they appear in the document. |
getDocType() | DocType | Gets the document's DocType declaration. |
getRootElement() | Element | Gets the document's root Element node. |
hasRootElement() | Boolean | Determines whether the document has a root Element node. |
removeContent() | Content[] | Removes all nodes that are immediate children of the document. |
removeContent(content) | Boolean | Removes the given node, if the node is an immediate child of the document. |
removeContent(index) | Content | Removes the node at the given index among all nodes that are immediate children of the document. |
setDocType(docType) | Document | Sets the document's DocType declaration. |
setRootElement(element) | Document | Sets the document's root Element node. |
Detailed documentation
addContent(content)
Appends the given node to the end of the document. The content
argument can be a Content
object or any node object that corresponds to a type listed in ContentType
. Note, however, that a document can only have one child Element
node, which is implicitly the root Element
node.
Parameters
Name | Type | Description |
---|---|---|
content | Content | the node to append |
Return
Document
— the document, for chaining
addContent(index, content)
Inserts the given node at the given index among all nodes that are immediate children of the
document. The content
argument can be a Content
object or any node object
that corresponds to a type listed in ContentType
. Note, however, that a document
can only have one child Element
node, which is implicitly the root Element
node.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | the index at which to insert the node among all nodes that are immediate children of the document |
content | Content | the node to insert |
Return
Document
— the document, for chaining
cloneContent()
Creates unattached copies of all nodes that are immediate children of the document.
Return
Content[]
— an array of unattached copies of all nodes that are immediate children of the
document
detachRootElement()
getAllContent()
Gets all nodes that are immediate children of the document.
Return
Content[]
— an array of all nodes that are immediate children of the document
getContent(index)
Gets the node at the given index among all nodes that are immediate children of the
document. If there is no node at the given index, this method returns null
.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | the index for the node among all nodes that are immediate children of the document |
Return
Content
— the node, or null
if there is no node at the given index
getContentSize()
Gets the number of nodes that are immediate children of the document.
Return
Integer
— the number of nodes that are immediate children of the document
getDescendants()
Gets all nodes that are direct or indirect children of the document, in the order they appear in the document.
Return
Content[]
— an array of all nodes that are direct or indirect children of the document
getDocType()
getRootElement()
hasRootElement()
Determines whether the document has a root Element
node.
Return
Boolean
— true
if the document has a root Element
node; false
if not
removeContent()
Removes all nodes that are immediate children of the document.
Return
Content[]
— an array of all nodes that were immediate children of the document before they
were removed
removeContent(content)
Removes the given node, if the node is an immediate child of the document. The content
argument can be a Content
object or any node object that corresponds to a
type listed in ContentType
.
Parameters
Name | Type | Description |
---|---|---|
content | Content | the node to remove |
Return
Boolean
— true
if the node was an immediate child and was removed; false
if not
removeContent(index)
Removes the node at the given index among all nodes that are immediate children of the
document. If there is no node at the given index, this method returns null
.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | the index for the node among all nodes that are immediate children of the document |
Return
Content
— the node that was removed, or null
if there is no node at the given index
setDocType(docType)
Sets the document's DocType
declaration. If the document already has a different
DocType
node, this method overwrites the old node. This method throws an exception if
the document already contains the same DocType
node that is being set.
Parameters
Name | Type | Description |
---|---|---|
docType | DocType | the DocumentType to set |
Return
Document
— the document, for chaining