Class Document

Document

Es una representación de un documento XML.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
addContent(content)	Document	Agrega el nodo determinado al final del documento.
addContent(index, content)	Document	Inserta el nodo determinado en el índice determinado entre todos los nodos que son hijos inmediatos del documento.
cloneContent()	Content[]	Crea copias no adjuntas de todos los nodos que son hijos inmediatos del documento.
detachRootElement()	Element|null	Desvincula y devuelve el nodo raíz Element del documento.
getAllContent()	Content[]	Obtiene todos los nodos que son elementos secundarios inmediatos del documento.
getContent(index)	Content|null	Obtiene el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento.
getContentSize()	Integer	Obtiene la cantidad de nodos que son hijos inmediatos del documento.
getDescendants()	Content[]	Obtiene todos los nodos que son elementos secundarios directos o indirectos del documento, en el orden en que aparecen en el documento.
getDocType()	DocType|null	Obtiene la declaración DocType del documento.
getRootElement()	Element|null	Obtiene el nodo Element raíz del documento.
hasRootElement()	Boolean	Determina si el documento tiene un nodo raíz Element.
removeContent()	Content[]	Quita todos los nodos que son hijos inmediatos del documento.
removeContent(content)	Boolean	Quita el nodo determinado si es un elemento secundario inmediato del documento.
removeContent(index)	Content|null	Quita el nodo en el índice determinado entre todos los nodos que son secundarios inmediatos del documento.
setDocType(docType)	Document	Establece la declaración DocType del documento.
setRootElement(element)	Document	Establece el nodo raíz Element del documento.

Documentación detallada

addContent(content)

Agrega el nodo determinado al final del documento. El argumento content puede ser un objeto Content o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType. Sin embargo, ten en cuenta que un documento solo puede tener un nodo secundario Element, que es implícitamente el nodo raíz Element.

Parámetros

Nombre	Tipo	Descripción
content	Content	Es el nodo que se anexará.

Volver

Document: El documento, para encadenar.

---

addContent(index, content)

Inserta el nodo determinado en el índice determinado entre todos los nodos que son hijos inmediatos del documento. El argumento content puede ser un objeto Content o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType. Sin embargo, ten en cuenta que un documento solo puede tener un nodo Element secundario, que es implícitamente el nodo Element raíz.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice en el que se insertará el nodo entre todos los nodos que son elementos secundarios inmediatos del documento.
content	Content	Es el nodo que se insertará.

Volver

Document: El documento, para encadenar.

---

cloneContent()

Crea copias no adjuntas de todos los nodos que son hijos inmediatos del documento.

Volver

Content[]: Es un array de copias no adjuntas de todos los nodos que son elementos secundarios inmediatos del documento.

---

detachRootElement()

Desvincula y devuelve el nodo raíz Element del documento. Si el documento no tiene un nodo raíz Element, este método devuelve null.

Volver

Element|null: Es el nodo Element separado o null si el documento no tiene un nodo Element raíz.

---

getAllContent()

Obtiene todos los nodos que son elementos secundarios inmediatos del documento.

Volver

Content[]: Es un array de todos los nodos que son elementos secundarios inmediatos del documento.

---

getContent(index)

Obtiene el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento. Si no hay ningún nodo en el índice determinado, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice del nodo entre todos los nodos que son hijos inmediatos del documento.

Volver

Content|null: El nodo o null si no hay ningún nodo en el índice determinado.

---

getContentSize()

Obtiene la cantidad de nodos que son hijos inmediatos del documento.

Volver

Integer: Es la cantidad de nodos que son hijos inmediatos del documento.

---

getDescendants()

Obtiene todos los nodos que son elementos secundarios directos o indirectos del documento, en el orden en que aparecen en el documento.

Volver

Content[]: Es un array de todos los nodos que son elementos secundarios directos o indirectos del documento.

---

getDocType()

Obtiene la declaración DocType del documento. Si el documento no tiene un nodo DocumentType, este método devuelve null.

Volver

DocType|null: Es el nodo DocumentType o null si el documento no tiene un nodo DocumentType.

---

getRootElement()

Obtiene el nodo Element raíz del documento. Si el documento no tiene un nodo raíz Element, este método devuelve null.

Volver

Element|null: Es el nodo Element raíz o null si el documento no tiene un nodo Element raíz.

---

hasRootElement()

Determina si el documento tiene un nodo raíz Element.

Volver

Boolean: true si el documento tiene un nodo raíz Element; false si no es así.

---

removeContent()

Quita todos los nodos que son hijos inmediatos del documento.

Volver

Content[]: Es un array de todos los nodos que eran elementos secundarios inmediatos del documento antes de que se quitaran.

---

removeContent(content)

Quita el nodo determinado si es un elemento secundario inmediato del documento. El argumento content puede ser un objeto Content o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType.

Parámetros

Nombre	Tipo	Descripción
content	Content	Es el nodo que se quitará.

Volver

Boolean: true si el nodo era un elemento secundario inmediato y se quitó; false si no.

---

removeContent(index)

Quita el nodo en el índice determinado entre todos los nodos que son secundarios inmediatos del documento. Si no hay ningún nodo en el índice determinado, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice del nodo entre todos los nodos que son hijos inmediatos del documento.

Volver

Content|null: Es el nodo que se quitó o null si no hay ningún nodo en el índice determinado.

---

setDocType(docType)

Establece la declaración DocType del documento. Si el documento ya tiene un nodo DocType diferente, este método sobrescribe el nodo anterior. Este método genera una excepción si el documento ya contiene el mismo nodo DocType que se está configurando.

Parámetros

Nombre	Tipo	Descripción
docType	DocType	Es el DocumentType que se establecerá.

Volver

Document: El documento, para encadenar.

---

setRootElement(element)

Establece el nodo raíz Element del documento. Si el documento ya tiene un nodo raíz Element, este método reemplaza el nodo anterior.

Parámetros

Nombre	Tipo	Descripción
element	Element	Es el nodo raíz Element que se establecerá.

Volver

Document: El documento, para encadenar.