Class Document

Document

Uma representação de um documento XML.

Métodos

MétodoTipo de retornoBreve descrição
addContent(content)DocumentAnexa o nó especificado ao final do documento.
addContent(index, content)DocumentInsere o nó especificado no índice indicado entre todos os nós que são filhos imediatos do documento.
cloneContent()Content[]Cria cópias não anexadas de todos os nós que são filhos imediatos do documento.
detachRootElement()Element|nullDesanexa e retorna o nó Element raiz do documento.
getAllContent()Content[]Recebe todos os nós que são filhos imediatos do documento.
getContent(index)Content|nullRecebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento.
getContentSize()IntegerRecebe o número de nós que são filhos imediatos do documento.
getDescendants()Content[]Recebe todos os nós que são filhos diretos ou indiretos do documento, na ordem em que aparecem nele.
getDocType()DocType|nullRecebe a declaração DocType do documento.
getRootElement()Element|nullRecebe o nó Element raiz do documento.
hasRootElement()BooleanDetermina se o documento tem um nó Element raiz.
removeContent()Content[]Remove todos os nós que são filhos imediatos do documento.
removeContent(content)BooleanRemove o nó especificado se ele for um filho imediato do documento.
removeContent(index)Content|nullRemove o nó no índice especificado entre todos os nós que são filhos imediatos do documento.
setDocType(docType)DocumentDefine a declaração DocType do documento.
setRootElement(element)DocumentDefine o nó Element raiz do documento.

Documentação detalhada

addContent(content)

Anexa o nó especificado ao final do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType. No entanto, um documento só pode ter um nó filho Element, que é implicitamente o nó raiz Element.

Parâmetros

NomeTipoDescrição
contentContentO nó a ser anexado.

Retornar

Document: o documento, para encadeamento.

addContent(index, content)

Insere o nó especificado no índice indicado entre todos os nós que são filhos imediatos do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType. No entanto, um documento só pode ter um nó filho Element, que é implicitamente o nó raiz Element.

Parâmetros

NomeTipoDescrição
indexIntegerO índice em que o nó será inserido entre todos os nós que são filhos imediatos do documento.
contentContentO nó a ser inserido.

Retornar

Document: o documento, para encadeamento.

cloneContent()

Cria cópias não anexadas de todos os nós que são filhos imediatos do documento.

Retornar

Content[]: uma matriz de cópias não anexadas de todos os nós que são filhos imediatos do documento.

detachRootElement()

Desanexa e retorna o nó Element raiz do documento. Se o documento não tiver um nó Element raiz, esse método vai retornar null.

Retornar

Element|null: o nó Element independente ou null se o documento não tiver um nó Element raiz.

getAllContent()

Recebe todos os nós que são filhos imediatos do documento.

Retornar

Content[]: uma matriz de todos os nós que são filhos imediatos do documento.

getContent(index)

Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento. Se não houver um nó no índice especificado, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
indexIntegerO índice do nó entre todos os nós que são filhos imediatos do documento.

Retornar

Content|null: o nó ou null se não houver um nó no índice especificado.

getContentSize()

Recebe o número de nós que são filhos imediatos do documento.

Retornar

Integer: o número de nós que são filhos imediatos do documento.

getDescendants()

Recebe todos os nós que são filhos diretos ou indiretos do documento, na ordem em que aparecem nele.

Retornar

Content[]: uma matriz de todos os nós que são filhos diretos ou indiretos do documento.

getDocType()

Recebe a declaração DocType do documento. Se o documento não tiver um nó DocumentType, esse método vai retornar null.

Retornar

DocType|null: o nó DocumentType ou null se o documento não tiver um nó DocumentType.

getRootElement()

Recebe o nó Element raiz do documento. Se o documento não tiver um nó Element raiz, esse método vai retornar null.

Retornar

Element|null: o nó Element raiz ou null se o documento não tiver um nó Element raiz.

hasRootElement()

Determina se o documento tem um nó Element raiz.

Retornar

Boolean: true se o documento tiver um nó Element raiz; false se não tiver.

removeContent()

Remove todos os nós que são filhos imediatos do documento.

Retornar

Content[]: uma matriz de todos os nós que eram filhos imediatos do documento antes de serem removidos.

removeContent(content)

Remove o nó especificado se ele for um filho imediato do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
contentContentO nó a ser removido.

Retornar

Boolean: true se o nó era um filho imediato e foi removido; false caso contrário.

removeContent(index)

Remove o nó no índice especificado entre todos os nós que são filhos imediatos do documento. Se não houver um nó no índice especificado, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
indexIntegerO índice do nó entre todos os nós que são filhos imediatos do documento.

Retornar

Content|null: o nó removido ou null se não houver um nó no índice especificado.

setDocType(docType)

Define a declaração DocType do documento. Se o documento já tiver um nó DocType diferente, esse método vai substituir o nó antigo. Esse método gera uma exceção se o documento já contiver o mesmo nó DocType que está sendo definido.

Parâmetros

NomeTipoDescrição
docTypeDocTypeO DocumentType a ser definido.

Retornar

Document: o documento, para encadeamento.

setRootElement(element)

Define o nó Element raiz do documento. Se o documento já tiver um nó Element raiz, esse método vai substituir o nó antigo.

Parâmetros

NomeTipoDescrição
elementElementO nó raiz Element a ser definido.

Retornar

Document: o documento, para encadeamento.