de.hybris.bootstrap.xml

Class XMLWriter

java.lang.Object

de.hybris.bootstrap.xml.XMLWriter

public class XMLWriter
extends java.lang.Object

XML document writer based upon a XMLTagWriter tree.

Use like this:

        XMLWriter wr = new XMLWriter( 
                new FileWriter( "test.xml" ),
                new MyRootTagWriter()
        );
        // optionally define the DTD
        wr.setDtd(
                new String[]{
                        "faces-config" // name 
                        "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.1//EN", // public
                        "http://java.sun.com/dtd/web-facesconfig_1_1.dtd"  // system
                }
        );
        // optionally set encoding
        wr.setEncoding("UTF-8");
        
        // write
        try
        {
                wr.write( new MyRootDataObject() );
        }
        catch( XMLWriteException e )
        {
                // report some error
        }
        finally
        {
                try{ wr.close() } catch( IOException e ){}
        }
 

Constructor Summary

Constructors

Constructor and Description
XMLWriter(java.io.OutputStream os, XMLTagWriter root) Creates a new xml writer which wraps a exiting OutputStream.
XMLWriter(java.io.Writer wr, XMLTagWriter root) Creates a new xml writer which wraps a exiting Writer.

Method Summary

Modifier and Type	Method and Description
void	close()
protected XMLOutputter	createXMLOutputter(java.io.Writer wr)
protected void	endDocument(XMLOutputter xout)
java.lang.String[]	getDtd()
java.lang.String	getEncoding()
java.lang.String	getIndent()
LineBreak	getLineBreak()
char	getQuotation()
XMLTagWriter	getRootTagWriter()
void	setDtd(java.lang.String[] dtd)
void	setEncoding(java.lang.String encoding)
void	setIndent(java.lang.String indent)
void	setLineBreak(LineBreak lineBreak)
void	setQuotation(char quotation)
protected void	startDocument(XMLOutputter xout)
void	write(java.lang.Object o)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWriter

public XMLWriter(java.io.Writer wr,
                 XMLTagWriter root)

Creates a new xml writer which wraps a exiting Writer.

Parameters:

wr - the underlying writer

root - the root tag writer, must contain all sub tag writers of the document

XMLWriter

public XMLWriter(java.io.OutputStream os,
                 XMLTagWriter root)

Creates a new xml writer which wraps a exiting OutputStream.

Parameters:

os - the underlying output stream

root - the root tag writer, must contain all sub tag writers of the document

Method Detail

createXMLOutputter

protected XMLOutputter createXMLOutputter(java.io.Writer wr)
                                   throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

write

public void write(java.lang.Object o)
           throws XMLWriteException

Throws:

XMLWriteException

startDocument

protected void startDocument(XMLOutputter xout)
                      throws XMLWriteException

Throws:

XMLWriteException

endDocument

protected void endDocument(XMLOutputter xout)

close

public void close()
           throws java.lang.IllegalStateException,
                  java.io.IOException

Throws:

java.lang.IllegalStateException

java.io.IOException

getDtd

public java.lang.String[] getDtd()

setDtd

public void setDtd(java.lang.String[] dtd)

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

getIndent

public java.lang.String getIndent()

setIndent

public void setIndent(java.lang.String indent)

getLineBreak

public LineBreak getLineBreak()

setLineBreak

public void setLineBreak(LineBreak lineBreak)

getQuotation

public char getQuotation()

setQuotation

public void setQuotation(char quotation)

getRootTagWriter

public XMLTagWriter getRootTagWriter()