org.apache.ddlutils.io

Class PrettyPrintingXmlWriter

java.lang.Object

org.apache.ddlutils.io.PrettyPrintingXmlWriter

Direct Known Subclasses:

DataWriter

public class PrettyPrintingXmlWriter
extends Object

Helper class that writes XML data with or without pretty printing.

Constructor Summary

Constructors

Constructor and Description
PrettyPrintingXmlWriter(OutputStream output) Creates a xml writer instance using UTF-8 encoding.
PrettyPrintingXmlWriter(OutputStream output, String encoding) Creates a xml writer instance.
PrettyPrintingXmlWriter(Writer output, String encoding) Creates a xml writer instance using the specified writer.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEncoding() Returnd the encoding used by this xml writer.
void	indentIfPrettyPrinting(int level) Prints the indentation if we're pretty-printing.
boolean	isPrettyPrinting() Determines whether the output shall be pretty-printed.
void	printlnIfPrettyPrinting() Prints a newline if we're pretty-printing.
void	setDefaultNamespace(String uri) Sets the default namespace.
void	setPrettyPrinting(boolean prettyPrinting) Specifies whether the output shall be pretty-printed.
protected void	throwException(Exception baseEx) Rethrows the given exception, wrapped in a DdlUtilsXMLException.
void	writeAttribute(String namespaceUri, String localPart, String value) Writes an XML attribute.
void	writeCData(String data) Writes a CDATA segment.
void	writeCharacters(String data) Writes a text segment.
void	writeDocumentEnd() Writes the end of the XML document, i.e.
void	writeDocumentStart() Writes the start of the XML document, i.e.
void	writeElementEnd() Writes the end of the current XML element.
void	writeElementStart(String namespaceUri, String localPart) Writes the start of the indicated XML element.
void	writeNamespace(String prefix, String namespaceUri) Writes a xmlns attribute to the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyPrintingXmlWriter

public PrettyPrintingXmlWriter(OutputStream output)
                        throws DdlUtilsXMLException

Creates a xml writer instance using UTF-8 encoding.

Parameters:

output - The target to write the data XML to

Throws:

DdlUtilsXMLException

PrettyPrintingXmlWriter

public PrettyPrintingXmlWriter(OutputStream output,
                       String encoding)
                        throws DdlUtilsXMLException

Creates a xml writer instance.

Parameters:

output - The target to write the data XML to

encoding - The encoding of the XML file

Throws:

DdlUtilsXMLException

PrettyPrintingXmlWriter

public PrettyPrintingXmlWriter(Writer output,
                       String encoding)
                        throws DdlUtilsXMLException

Creates a xml writer instance using the specified writer. Note that the writer needs to be configured using the specified encoding.

Parameters:

output - The target to write the data XML to

encoding - The encoding of the writer

Throws:

DdlUtilsXMLException

Method Detail

getEncoding

public String getEncoding()

Returnd the encoding used by this xml writer.

Returns:

The encoding

throwException

protected void throwException(Exception baseEx)
                       throws DdlUtilsXMLException

Rethrows the given exception, wrapped in a DdlUtilsXMLException. This method allows subclasses to throw their own subclasses of this exception.

Parameters:

baseEx - The original exception

Throws:

DdlUtilsXMLException - The wrapped exception

isPrettyPrinting

public boolean isPrettyPrinting()

Determines whether the output shall be pretty-printed.

Returns:

true if the output is pretty-printed

setPrettyPrinting

public void setPrettyPrinting(boolean prettyPrinting)

Specifies whether the output shall be pretty-printed.

Parameters:

prettyPrinting - true if the output is pretty-printed

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws DdlUtilsXMLException

Sets the default namespace.

Parameters:

uri - The namespace uri

Throws:

DdlUtilsXMLException

printlnIfPrettyPrinting

public void printlnIfPrettyPrinting()
                             throws DdlUtilsXMLException

Prints a newline if we're pretty-printing.

Throws:

DdlUtilsXMLException

indentIfPrettyPrinting

public void indentIfPrettyPrinting(int level)
                            throws DdlUtilsXMLException

Prints the indentation if we're pretty-printing.

Parameters:

level - The indentation level

Throws:

DdlUtilsXMLException

writeDocumentStart

public void writeDocumentStart()
                        throws DdlUtilsXMLException

Writes the start of the XML document, i.e. the "" section and the start of the root node.

Throws:

DdlUtilsXMLException

writeDocumentEnd

public void writeDocumentEnd()
                      throws DdlUtilsXMLException

Writes the end of the XML document, i.e. end of the root node.

Throws:

DdlUtilsXMLException

writeNamespace

public void writeNamespace(String prefix,
                  String namespaceUri)
                    throws DdlUtilsXMLException

Writes a xmlns attribute to the stream.

Parameters:

prefix - The prefix for the namespace, use null or an empty string for the default namespace

namespaceUri - The namespace uri, can be null

Throws:

DdlUtilsXMLException

writeElementStart

public void writeElementStart(String namespaceUri,
                     String localPart)
                       throws DdlUtilsXMLException

Writes the start of the indicated XML element.

Parameters:

namespaceUri - The namespace uri, can be null

localPart - The local part of the element's qname

Throws:

DdlUtilsXMLException

writeElementEnd

public void writeElementEnd()
                     throws DdlUtilsXMLException

Writes the end of the current XML element.

Throws:

DdlUtilsXMLException

writeAttribute

public void writeAttribute(String namespaceUri,
                  String localPart,
                  String value)
                    throws DdlUtilsXMLException

Writes an XML attribute.

Parameters:

namespaceUri - The namespace uri, can be null

localPart - The local part of the attribute's qname

value - The value; if null then no attribute is written

Throws:

DdlUtilsXMLException

writeCData

public void writeCData(String data)
                throws DdlUtilsXMLException

Writes a CDATA segment.

Parameters:

data - The data to write

Throws:

DdlUtilsXMLException

writeCharacters

public void writeCharacters(String data)
                     throws DdlUtilsXMLException

Writes a text segment.

Parameters:

data - The data to write

Throws:

DdlUtilsXMLException