net.sf.xisemele.api
Interface Xisemele

All Superinterfaces:

java.io.Serializable

public interface Xisemele
extends java.io.Serializable

Definição de interface principal da API.

Uma instância de Xisemele deve ser obtida através da fábrica XisemeleFactory e configurada para criar um Reader, um Writer ou um Editor para documentos XML.

Author:

Carlos Eduardo Coral.

Method Summary

Editor	createEditor(java.io.File file) Cria uma nova instância de Editor que irá editar o XML a partir de um arquivo.
Editor	createEditor(java.io.InputStream inputStream) Cria uma nova instância de Editor que irá editar o XML a partir de um java.io.InputStream.
Editor	createEditor(java.lang.String xml) Cria uma instância de Editor a partir de java.lang.String contendo o XML que será editado.
Reader	createReader(java.io.File file) Cria uma nova instância de Reader que irá ler o XML a partir de um arquivo.
Reader	createReader(java.io.InputStream inputStream) Cria uma nova instância de Reader que irá ler o XML a partir de um java.io.InputStream.
Reader	createReader(java.lang.String xml) Cria uma instância de Reader a partir de java.lang.String contendo o XML que será lido.
Writer	createWriter(java.lang.String rootElement) Cria uma nova instância de Writer configurada de acordo com o estado da instância de Xisemele do qual o método foi chamado.
Writer	createWriter(java.lang.String rootElement, java.lang.String xmlVersion) Cria uma nova instância de Writer configurada de acordo com o estado da instância de Xisemele.
Xisemele	setDatePattern(java.lang.String datePattern) Define o padrão para formatação de datas.
Xisemele	setFormatter(Formatter<?> formatter) Atribui um novo Formatter.

Method Detail

setFormatter

Xisemele setFormatter(Formatter<?> formatter)

Atribui um novo Formatter.

Parameters:

formatter - instância de Formatter que será atribuída.

Returns:

instância de Xisemele para permitir interface fluente.

setDatePattern

Xisemele setDatePattern(java.lang.String datePattern)

Define o padrão para formatação de datas.

O padrão default de uma instância de Xisemele para data é MM/dd/yyyy.

Parameters:

datePattern - java.lang.String contendo o padrão que será aplicado para datas.

Returns:

instância de Xisemele para permitir interface fluente.

createReader

Reader createReader(java.lang.String xml)
                    throws ParseXMLException

Cria uma instância de Reader a partir de java.lang.String contendo o XML que será lido.

Parameters:

xml - java.lang.String contendo o XML que será lido pela nova instância de Reader.

Returns:

nova instância de Reader para a java.lang.String especificada por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createReader

Reader createReader(java.io.File file)
                    throws ParseXMLException

Cria uma nova instância de Reader que irá ler o XML a partir de um arquivo.

Parameters:

file - instância de java.io.File correspondente ao arquivo que será lido.

Returns:

nova instância de Reader para o java.io.File especificado por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createReader

Reader createReader(java.io.InputStream inputStream)
                    throws ParseXMLException

Cria uma nova instância de Reader que irá ler o XML a partir de um java.io.InputStream.

Parameters:

inputStream - instância de java.io.InputStream correspondente ao XML que será lido.

Returns:

nova instância de Reader para o java.io.InputStream especificado por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createEditor

Editor createEditor(java.lang.String xml)
                    throws ParseXMLException

Cria uma instância de Editor a partir de java.lang.String contendo o XML que será editado.

A instância de Editor retornada tem por default o elemento raiz do documento XML definido como elemento corrente de edição.

Parameters:

xml - java.lang.String contendo o XML que será editado pela nova instância de Reader.

Returns:

nova instância de Editor para a java.lang.String especificada por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createEditor

Editor createEditor(java.io.File file)
                    throws ParseXMLException

Cria uma nova instância de Editor que irá editar o XML a partir de um arquivo.

A instância de Editor retornada tem por default o elemento raiz do documento XML definido como elemento corrente de edição.

Parameters:

file - instância de java.io.File correspondente ao arquivo que será editado.

Returns:

nova instância de Editor para o java.io.File especificado por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createEditor

Editor createEditor(java.io.InputStream inputStream)
                    throws ParseXMLException

Cria uma nova instância de Editor que irá editar o XML a partir de um java.io.InputStream.

A instância de Editor retornada tem por default o elemento raiz do documento XML definido como elemento corrente de edição.

Parameters:

inputStream - instância de java.io.InputStream correspondente ao XML que será editado.

Returns:

nova instância de Editor para o java.io.InputStream especificado por parâmetro.

Throws:

ParseXMLException - exceção disparada caso ocorra algum erro ao efetuar o parse do XML especificado.

createWriter

Writer createWriter(java.lang.String rootElement)

Cria uma nova instância de Writer configurada de acordo com o estado da instância de Xisemele do qual o método foi chamado.

Parameters:

rootElement - java.lang.String contendo o nome do elemento raiz do documento XML.

Returns:

nova instância de Writer.

createWriter

Writer createWriter(java.lang.String rootElement,
                    java.lang.String xmlVersion)

Cria uma nova instância de Writer configurada de acordo com o estado da instância de Xisemele.

Parameters:

rootElement - java.lang.String contendo o nome do elemento raiz do documento XML.

xmlVersion - java.lang.String contendo a versão do documento XML.

Returns:

nova instância de Writer.