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 especificado 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()ElementRemove e retorna o nó raiz Element do documento.
getAllContent()Content[]Extrai todos os nós que são filhos imediatos do documento.
getContent(index)ContentRecebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento.
getContentSize()IntegerExtrai o número de nós que são filhos imediatos do documento.
getDescendants()Content[]Extrai todos os nós que são filhos diretos ou indiretos do documento, na ordem em que aparecem.
getDocType()DocTypeRecebe a declaração DocType do documento.
getRootElement()ElementRecebe 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 o nó for um filho imediato do documento.
removeContent(index)ContentRemove 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ó Element filho, que é implicitamente o nó raiz Element.

Parâmetros

NomeTipoDescrição
contentContento nó a ser anexado

Retorno

Document: o documento para encadeamento.


addContent(index, content)

Insere o nó especificado no índice especificado 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ó Element filho, que é implicitamente o nó raiz Element.

Parâmetros

NomeTipoDescrição
indexIntegero índice em que inserir o nó entre todos os nós que são filhos imediatos do documento
contentContento nó a ser inserido

Retorno

Document: o documento para encadeamento.


cloneContent()

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

Retorno

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


detachRootElement()

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

Retorno

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


getAllContent()

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

Retorno

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 nenhum nó no índice especificado, esse método retornará null.

Parâmetros

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

Retorno

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


getContentSize()

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

Retorno

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


getDescendants()

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

Retorno

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 retornará null.

Retorno

DocType: 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 retorna null.

Retorno

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


hasRootElement()

Determina se o documento tem um nó Element raiz.

Retorno

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.

Retorno

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 o nó 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

Retorno

Boolean: true se o nó era um filho imediato e foi removido; false se não for


removeContent(index)

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

Parâmetros

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

Retorno

Content: o nó que foi removido ou null se não houver 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á tiver o mesmo nó DocType que está sendo definido.

Parâmetros

NomeTipoDescrição
docTypeDocTypeo DocumentType que será definido

Retorno

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 substituirá o nó antigo.

Parâmetros

NomeTipoDescrição
elementElemento nó raiz Element a ser definido

Retorno

Document: o documento para encadeamento.