Class Document

Document

Es una representación de un documento XML.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addContent(content)DocumentAnexa el nodo determinado al final del documento.
addContent(index, content)DocumentInserta el nodo determinado en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento.
cloneContent()Content[]Crea copias no adjuntas de todos los nodos que son elementos secundarios inmediatos del documento.
detachRootElement()Element|nullDesvincula y muestra el nodo Element raíz del documento.
getAllContent()Content[]Obtiene todos los nodos que son elementos secundarios inmediatos del documento.
getContent(index)Content|nullObtiene el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento.
getContentSize()IntegerObtiene la cantidad de nodos que son elementos secundarios 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|nullObtiene la declaración DocType del documento.
getRootElement()Element|nullObtiene el nodo Element raíz del documento.
hasRootElement()BooleanDetermina si el documento tiene un nodo Element raíz.
removeContent()Content[]Quita todos los nodos que son elementos secundarios inmediatos del documento.
removeContent(content)BooleanQuita el nodo determinado si es un elemento secundario inmediato del documento.
removeContent(index)Content|nullQuita el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento.
setDocType(docType)DocumentEstablece la declaración DocType del documento.
setRootElement(element)DocumentEstablece el nodo Element raíz del documento.

Documentación detallada

addContent(content)

Anexa 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 aparece 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

NombreTipoDescripción
contentContentEl nodo que se anexará.

Volver

Document: El documento, para el encadenamiento.


addContent(index, content)

Inserta el nodo determinado en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del documento. El argumento content puede ser un objeto Content o cualquier objeto de nodo que corresponda a un tipo que aparece 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

NombreTipoDescripción
indexIntegerEl índice en el que se insertará el nodo entre todos los nodos que son elementos secundarios inmediatos del documento.
contentContentEl nodo que se insertará.

Volver

Document: El documento, para el encadenamiento.


cloneContent()

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

Volver

Content[] — Un array de copias no adjuntas de todos los nodos que son elementos secundarios inmediatos del documento.


detachRootElement()

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

Volver

Element|null — El nodo Element desvinculado 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[]: 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 muestra null.

Parámetros

NombreTipoDescripción
indexIntegerEl índice del nodo entre todos los nodos que son elementos secundarios 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 elementos secundarios inmediatos del documento.

Volver

Integer: La cantidad de nodos que son elementos secundarios 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[]: 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 muestra null.

Volver

DocType|null — 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 Element raíz, este método muestra null.

Volver

Element|null — 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 Element raíz.

Volver

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


removeContent()

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

Volver

Content[] — 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 aparece en ContentType.

Parámetros

NombreTipoDescripción
contentContentEl 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 elementos secundarios inmediatos del documento. Si no hay ningún nodo en el índice determinado, este método muestra null.

Parámetros

NombreTipoDescripción
indexIntegerEl índice del nodo entre todos los nodos que son elementos secundarios inmediatos del documento.

Volver

Content|null — 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 reemplaza el nodo anterior. Este método arroja una excepción si el documento ya contiene el mismo nodo DocType que se está configurando.

Parámetros

NombreTipoDescripción
docTypeDocTypeEl DocumentType que se establecerá.

Volver

Document: El documento, para el encadenamiento.


setRootElement(element)

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

Parámetros

NombreTipoDescripción
elementElementEl nodo Element raíz que se establecerá.

Volver

Document: El documento, para el encadenamiento.