net.sf.xisemele.api
Interface Writer

All Superinterfaces:

java.io.Serializable

public interface Writer
extends java.io.Serializable

Definição de interface de escrita de XML.

Author:

Carlos Eduardo Coral.

Method Summary

Writer	attribute(java.lang.String name, java.util.Date date, java.lang.String pattern) Especifica um novo atributo para o elemento corrente do documento XML.
Writer	attribute(java.lang.String name, java.lang.Object value) Especifica um novo atributo para o elemento corrente do documento XML.
org.w3c.dom.Document	document() Retorna instância de org.w3c.dom.Document correspondente ao documento XML criado.
Writer	element(Element element) Adiciona um novo Element no nível corrente do documento XML.
Writer	element(java.lang.String name) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Writer	element(java.lang.String name, java.util.Date date, java.lang.String pattern) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Writer	element(java.lang.String name, java.lang.Object value) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Writer	endWithin() Finaliza um nível da última chamada do método within().
Result	result() Retorna a instância de Result correspondente ao documento XML escrito.
Writer	within() Inicia um contexto para inserção de elementos filhos para o último elemento adicionado.

Method Detail

element

Writer element(java.lang.String name)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Writer element(java.lang.String name,
               java.lang.Object value)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

value - objeto que será atribuído como valor do novo elemento.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Writer element(java.lang.String name,
               java.util.Date date,
               java.lang.String pattern)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

date - instância de java.util.Date que será atribuída como valor do novo elemento.

pattern - java.lang.String contendo o padrão que será aplicado na formatação da data especificada por parâmetro.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Writer element(Element element)
               throws RootDuplicateException

Adiciona um novo Element no nível corrente do documento XML.

Parameters:

element - instância de Element que será adicionada.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quanto tentar adicionar mais de um elemento raiz no documento XML.

within

Writer within()
              throws WithinContextNotPermittedException

Inicia um contexto para inserção de elementos filhos para o último elemento adicionado. Ou seja, os elementos adicionados a partir da chamada desse método serão filhos do último elemento adicionado.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

WithinContextNotPermittedException

endWithin

Writer endWithin()
                 throws NotWithinContextException

Finaliza um nível da última chamada do método within().

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

NotWithinContextException - exceção disparada caso o método seja chamado fora de um contexto within.

attribute

Writer attribute(java.lang.String name,
                 java.lang.Object value)
                 throws AttributeNotPermittedException,
                        InvalidNameException

Especifica um novo atributo para o elemento corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo atributo.

value - objeto que será atribuído como valor do novo atributo.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

AttributeNotPermittedException - exceção disparada se não for permitido especificar um atributo para o elemento corrente.

InvalidNameException - exceção disparada se for especificado um nome inválido.

attribute

Writer attribute(java.lang.String name,
                 java.util.Date date,
                 java.lang.String pattern)
                 throws AttributeNotPermittedException,
                        InvalidNameException

Especifica um novo atributo para o elemento corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo atributo.

date - instância de java.util.Date que será atribuída como valor no novo atributo.

pattern - java.lang.String contendo o padrão que será aplicado na formatação da data especificada por parâmetro.

Returns:

instância corrente de Writer para permitir interface fluente.

Throws:

AttributeNotPermittedException - exceção disparada se não for permitido especificar um atributo para o elemento corrente.

InvalidNameException - exceção disparada se for especificado um nome inválido.

result

Result result()

Retorna a instância de Result correspondente ao documento XML escrito.

Returns:

instância de Result correspondente ao documento XML escrito.

document

org.w3c.dom.Document document()

Retorna instância de org.w3c.dom.Document correspondente ao documento XML criado.

Returns:

instância de org.w3c.dom.Document correspondente ao documento XML criado.