net.sf.xisemele.api
Interface Result

All Superinterfaces:

java.io.Serializable

public interface Result
extends java.io.Serializable

Definição de interface para a transformação da escrita/edição de determinado documento XML para outro formato.

Author:

Carlos Eduardo Coral.

Method Summary

Result	encoding(java.lang.String encoding) Especifica o encoding que será aplicado na transformação.
Result	ident(boolean ident) Especifica se o XML será identado ou não.
Result	identNumber(int identNumber) Especifica a quantidade de espaços que será aplicada na identação do XML.
Result	toFile(java.io.File file) Transforma o XML para o arquivo especificado por parâmetro.
Result	toFile(java.lang.String fileName) Transforma o XML para o arquivo do qual o nome é especificado por parâmetro.
java.lang.String	toXML() Transforma o XML para java.lang.String.

Method Detail

encoding

Result encoding(java.lang.String encoding)

Especifica o encoding que será aplicado na transformação.

Parameters:

encoding - java.lang.String contendo o encoding que será aplicado na transformação.

Returns:

instância corrente de Result para permitir interface fluente.

ident

Result ident(boolean ident)

Especifica se o XML será identado ou não.

Parameters:

ident - true indicando que o XML será identado.

Returns:

instância corrente de Result para permitir interface fluente.

identNumber

Result identNumber(int identNumber)

Especifica a quantidade de espaços que será aplicada na identação do XML.

O valor especificado será considerado para a transformação somente se tiver sido especificado o valor true para o método ident(boolean).

Parameters:

identNumber - int indicando a quantidade de espaços.

Returns:

instância corrente de Result para permitir interface fluente.

toFile

Result toFile(java.lang.String fileName)
              throws XisemeleIOException

Transforma o XML para o arquivo do qual o nome é especificado por parâmetro.

Parameters:

fileName - java.lang.String contendo o nome do arquivo que será gravado.

Returns:

instância corrente de Result para permitir interface fluente.

Throws:

XisemeleIOException - exceção disparada caso ocorra algum erro ao escrever o arquivo.

toFile

Result toFile(java.io.File file)
              throws XisemeleIOException

Transforma o XML para o arquivo especificado por parâmetro.

Parameters:

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

Returns:

instância corrente de Result para permitir interface fluente.

Throws:

XisemeleIOException - exceção disparada caso ocorra algum erro ao escrever o arquivo.

toXML

java.lang.String toXML()
                       throws TransformException

Transforma o XML para java.lang.String.

Returns:

java.lang.String correspondente ao XML transformado.

Throws:

TransformException - exceção disparada caso ocorra algum erro ao transformar o XML.