tecgraf.javautils.xml

Class XMLWriter

java.lang.Object

tecgraf.javautils.xml.XMLWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class XMLWriter
extends Object
implements Closeable

Grava em um stream o XML gerado a partir de objetos da aplicação.

Author:

Andre Oliveira da Costa

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET Charset default (ISO-8859-1).

Constructor Summary

Constructors

Constructor and Description
XMLWriter(Object rootObject, Map<Class<?>,String> objToTagMap, String dtd, Charset charset) Cria um escritor que usa um mapa para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, Map<Class<?>,String> objToTagMap, String dtd, String charset) Cria um escritor que usa um mapa para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, Object appContext, XMLElementFactoryInterface xmlFactory) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, Object appContext, XMLElementFactoryInterface xmlFactory, String dtd) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, Object appContext, XMLElementFactoryInterface xmlFactory, String dtd, Charset charset) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, Object appContext, XMLElementFactoryInterface xmlFactory, String dtd, String encoding) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, XMLElementFactoryInterface xmlFactory) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, XMLElementFactoryInterface xmlFactory, String dtd) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, XMLElementFactoryInterface xmlFactory, String dtd, Charset charset) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.
XMLWriter(Object rootObject, XMLElementFactoryInterface xmlFactory, String dtd, String encoding) Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Fecha o writer.
static String	getDefaultIdent() Retorna a string de identação default usada pelo writer.
XMLElementFactoryInterface	getXmlFactory() Retorna a fábrica de elementos usada pelo writer.
void	setDefaultIdent(String ident) Define a string de identação a ser usada pelo writer.
void	write() Escreve o documento na saída padrão (System.out).
void	write(OutputStream stream) Escreve o documento em um OutputStream, usando o charset especificado para este XMLWriter.
void	write(Writer w) Escreve o documento em um Writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Charset default (ISO-8859-1).

Constructor Detail

XMLWriter

public XMLWriter(Object rootObject,
         Map<Class<?>,String> objToTagMap,
         String dtd,
         Charset charset)
          throws XMLException

Cria um escritor que usa um mapa para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

objToTagMap - mapa relacionando objetos a tags

dtd - DTD (pode ser null)

charset - codificação de caracteres do documento

Throws:

XMLException - se o elemento XML retornado pela fábrica para o objeto fornecido for null.

XMLWriter

public XMLWriter(Object rootObject,
         Map<Class<?>,String> objToTagMap,
         String dtd,
         String charset)
          throws XMLException

Cria um escritor que usa um mapa para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

objToTagMap - mapa relacionando objetos a tags

dtd - DTD (pode ser null)

charset - nome do charset usado no documento

Throws:

XMLException - se o elemento XML retornado pela fábrica para o objeto fornecido for null.

XMLWriter

public XMLWriter(Object rootObject,
         XMLElementFactoryInterface xmlFactory,
         String dtd,
         Charset charset)
          throws XMLException

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

charset - codificação de caracteres do documento

Throws:

XMLException - se o elemento XML retornado pela fábrica para o objeto fornecido for null.

XMLWriter

public XMLWriter(Object rootObject,
         XMLElementFactoryInterface xmlFactory,
         String dtd,
         String encoding)
          throws XMLException

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

encoding - codificação de caracteres do documento

Throws:

XMLException - se houver algum erro na geração do documento

XMLWriter

public XMLWriter(Object rootObject,
         Object appContext,
         XMLElementFactoryInterface xmlFactory,
         String dtd,
         String encoding)
          throws XMLException

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

appContext - contexto da aplicação, pode ser acessado pelos elementos XML quando estes estão sendo processados

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

encoding - codificação de caracteres do documento

Throws:

XMLException - se houver algum erro na geração do documento

XMLWriter

public XMLWriter(Object rootObject,
         Object appContext,
         XMLElementFactoryInterface xmlFactory,
         String dtd,
         Charset charset)
          throws XMLException

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

appContext - contexto da aplicação, pode ser acessado pelos elementos XML quando estes estão sendo processados

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

charset - charset a ser usado na geração do documento

Throws:

XMLException - se houver algum erro na geração do documento

XMLWriter

public XMLWriter(Object rootObject,
         XMLElementFactoryInterface xmlFactory,
         String dtd)

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação. Usa o encoding default.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

See Also:

XMLWriter(Object, XMLElementFactoryInterface, String, Charset)

XMLWriter

public XMLWriter(Object rootObject,
         Object appContext,
         XMLElementFactoryInterface xmlFactory,
         String dtd)

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação. Usa o encoding default.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

appContext - contexto da aplicação, pode ser acessado pelos elementos XML quando estes estão sendo processados

xmlFactory - fábrica de elementos XML

dtd - DTD a ser usado

See Also:

XMLWriter(Object, XMLElementFactoryInterface, String, Charset)

XMLWriter

public XMLWriter(Object rootObject,
         XMLElementFactoryInterface xmlFactory)

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação. Usa o encoding default.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

xmlFactory - fábrica de elementos XML

XMLWriter

public XMLWriter(Object rootObject,
         Object appContext,
         XMLElementFactoryInterface xmlFactory)

Cria um escritor que usa uma fábrica para criar tags a partir de objetos da aplicação. Usa o encoding default.

Parameters:

rootObject - objeto da aplicação correspondente à raiz do XML

appContext - contexto da aplicação, pode ser acessado pelos elementos XML quando estes estão sendo processados

xmlFactory - fábrica de elementos XML

Method Detail

getDefaultIdent

public static String getDefaultIdent()

Retorna a string de identação default usada pelo writer.

Returns:

string de identação default.

getXmlFactory

public final XMLElementFactoryInterface getXmlFactory()

Retorna a fábrica de elementos usada pelo writer.

Returns:

fábrica de elementos usada pelo writer.

setDefaultIdent

public final void setDefaultIdent(String ident)

Define a string de identação a ser usada pelo writer.

Parameters:

ident - string de identação.

write

public final void write()
                 throws XMLException

Escreve o documento na saída padrão (System.out).

Throws:

XMLException - em caso de erro.

write

public final void write(Writer w)

Escreve o documento em um Writer.

IMPORTANTE: o Writer recebido como parâmetro pode ter definido um charset diferente daquele especificado para este XMLWriter. Para garantir que o charset correto seja usado, use write(OutputStream).

Parameters:

w - stream de saída

See Also:

write(OutputStream)

write

public final void write(OutputStream stream)

Escreve o documento em um OutputStream, usando o charset especificado para este XMLWriter.

Parameters:

stream -

See Also:

write(Writer)

close

public void close()
           throws IOException

Fecha o writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - se houver algum erro no fechamento do writer.