Package org.dellroad.stuff.xml

Class IndentXMLStreamWriter

java.lang.Object

org.dellroad.stuff.xml.StreamWriterDelegate

org.dellroad.stuff.xml.IndentXMLStreamWriter

All Implemented Interfaces:

XMLStreamWriter

public class IndentXMLStreamWriter
extends StreamWriterDelegate

Wrapper for an underlying XMLStreamWriter that "pretty-prints" the XML by replacing the whitespace between XML tags so that the result is properly indented.

This class will also fixup a missing/incomplete initial XML declaration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ENCODING	Initial value for the default character encoding.
static final int	DEFAULT_INDENT	Default number of spaces corresponding to one indent level.
static final String	DEFAULT_VERSION	Initial value for the default XML version.

Constructor Summary

Constructors

Constructor	Description
IndentXMLStreamWriter()	Default constructor.
IndentXMLStreamWriter(XMLStreamWriter writer)	Convenience constructor.
IndentXMLStreamWriter(XMLStreamWriter writer, int indent)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
void	setAddMissingXmlDeclaration(boolean addMissingXmlDeclaration)	Set whether to add an XML declaration, if missing.
void	setDefaultEncoding(String defaultEncoding)	Set the character encoding for the XML declaration in case it's not already specified.
void	setDefaultVersion(String defaultVersion)	Set the version for the XML declaration in case it's not already specified.
void	setIndentAfterXmlDeclaration(boolean indentAfterXmlDeclaration)	Set whether to "indent" (actually, just output a newline) after the XML declaration if necessary.
void	writeCData(String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(String text)
void	writeComment(String data)
void	writeDTD(String dtd)
void	writeEmptyElement(String localName)
void	writeEmptyElement(String namespaceURI, String localName)
void	writeEmptyElement(String prefix, String namespaceURI, String localName)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String name)
void	writeProcessingInstruction(String target)
void	writeProcessingInstruction(String target, String data)
void	writeStartDocument()
void	writeStartDocument(String version)
void	writeStartDocument(String encoding, String version)
void	writeStartElement(String localName)
void	writeStartElement(String namespaceURI, String localName)
void	writeStartElement(String prefix, String namespaceURI, String localName)

Methods inherited from class org.dellroad.stuff.xml.StreamWriterDelegate

close, flush, getNamespaceContext, getParent, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setParent, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeDefaultNamespace, writeNamespace

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_VERSION

public static final String DEFAULT_VERSION

Initial value for the default XML version.

See Also:

• Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

Initial value for the default character encoding.

See Also:

• Constant Field Values

DEFAULT_INDENT

public static final int DEFAULT_INDENT

Default number of spaces corresponding to one indent level.

See Also:

• Constant Field Values

Constructor Details

IndentXMLStreamWriter

public IndentXMLStreamWriter()

Default constructor. Sets the indent to DEFAULT_INDENT. The parent must be configured via setParent().

IndentXMLStreamWriter

public IndentXMLStreamWriter(XMLStreamWriter writer)

Convenience constructor. Equivalent to:

IndentXMLStreamWriter(writer, DEFAULT_INDENT);

Parameters:

writer - underlying writer

IndentXMLStreamWriter

public IndentXMLStreamWriter(XMLStreamWriter writer,
 int indent)

Primary constructor.

Parameters:

writer - underlying writer

indent - number of spaces corresponding to one indent level, or negative for no inter-tag whitespace at all

Method Details

setAddMissingXmlDeclaration

public void setAddMissingXmlDeclaration(boolean addMissingXmlDeclaration)

Set whether to add an XML declaration, if missing.

Default is true.

Parameters:

addMissingXmlDeclaration - true to add XML declaration

setIndentAfterXmlDeclaration

public void setIndentAfterXmlDeclaration(boolean indentAfterXmlDeclaration)

Set whether to "indent" (actually, just output a newline) after the XML declaration if necessary. In some cases, such as transforming into a DOM, this behavior must be disabled to avoid hierarchy exceptions due to characters not being allowed before the document element.

Default is true.

Parameters:

indentAfterXmlDeclaration - true to indent after XML declaration

setDefaultVersion

public void setDefaultVersion(String defaultVersion)

Set the version for the XML declaration in case it's not already specified.

Default is DEFAULT_VERSION ("1.0").

Parameters:

defaultVersion - XML version

setDefaultEncoding

public void setDefaultEncoding(String defaultEncoding)

Set the character encoding for the XML declaration in case it's not already specified.

Default is DEFAULT_ENCODING ("UTF-8").

Parameters:

defaultEncoding - character encoding name

writeStartDocument

public void writeStartDocument(String encoding,
 String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
 String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
 String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Overrides:

writeComment in class StreamWriterDelegate

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Overrides:

writeProcessingInstruction in class StreamWriterDelegate

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
 String data)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Overrides:

writeProcessingInstruction in class StreamWriterDelegate

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Overrides:

writeCData in class StreamWriterDelegate

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Overrides:

writeDTD in class StreamWriterDelegate

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Overrides:

writeEntityRef in class StreamWriterDelegate

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Overrides:

writeCharacters in class StreamWriterDelegate

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
 int start,
 int len)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Overrides:

writeCharacters in class StreamWriterDelegate

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Overrides:

writeEndDocument in class StreamWriterDelegate

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Overrides:

writeEndElement in class StreamWriterDelegate

Throws:

XMLStreamException