javanet.staxutils

Class IndentingXMLStreamWriter

java.lang.Object

javanet.staxutils.helpers.StreamWriterDelegate

javanet.staxutils.IndentingXMLStreamWriter

All Implemented Interfaces:

Indentation, javax.xml.stream.XMLStreamWriter

public class IndentingXMLStreamWriter
extends StreamWriterDelegate
implements Indentation

A filter that indents an XML stream. To apply it, construct a filter that contains another XMLStreamWriter, which you pass to the constructor. Then call methods of the filter instead of the contained stream. For example:

 XMLStreamWriter stream = ...
 stream = new IndentingXMLStreamWriter(stream);
 stream.writeStartDocument();
 ...
 

The filter inserts characters to format the document as an outline, with nested elements indented. Basically, it inserts a line break and whitespace before:

• each DTD, processing instruction or comment that's not preceded by data
• each starting tag that's not preceded by data
• each ending tag that's preceded by nested elements but not data

This works well with 'data-oriented' XML, wherein each element contains either data or nested elements but not both. It can work badly with other styles of XML. For example, the data in a 'mixed content' document are apt to be polluted with indentation characters.

Indentation can be adjusted by setting the newLine and indent properties. But set them to whitespace only, for best results. Non-whitespace is apt to cause problems, for example when this class attempts to insert newLine before the root element.

Author:

John Kristian

Field Summary

Fields inherited from class javanet.staxutils.helpers.StreamWriterDelegate

out

Fields inherited from interface javanet.staxutils.Indentation

DEFAULT_INDENT, NORMAL_END_OF_LINE

Constructor Summary

Constructors

Constructor and Description
IndentingXMLStreamWriter(javax.xml.stream.XMLStreamWriter out)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterData() Note that data were written.
protected void	afterEndDocument() Note that a document was ended.
protected void	afterEndElement() Note that an element was ended.
protected void	afterMarkup() Note that markup or indentation was written.
protected void	afterStartElement() Note that an element was started.
protected void	beforeEndElement() Prepare to end an element, by writing a new line and indentation.
protected void	beforeMarkup() Prepare to write markup, by writing a new line and indentation.
protected void	beforeStartElement() Prepare to start an element, by allocating stack space.
java.lang.String	getIndent() The characters used for one level of indentation.
static java.lang.String	getLineSeparator()
java.lang.String	getNewLine() The characters that introduce a new line.
void	setIndent(java.lang.String indent) Set the characters used for one level of indentation.
void	setNewLine(java.lang.String newLine) Set the characters that introduce a new line.
void	writeCData(java.lang.String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(java.lang.String text)
void	writeComment(java.lang.String data)
void	writeDTD(java.lang.String dtd)
void	writeEmptyElement(java.lang.String localName)
void	writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(java.lang.String name)
protected void	writeNewLine(int indentation) Write a line separator followed by indentation.
void	writeProcessingInstruction(java.lang.String target)
void	writeProcessingInstruction(java.lang.String target, java.lang.String data)
void	writeStartDocument()
void	writeStartDocument(java.lang.String version)
void	writeStartDocument(java.lang.String encoding, java.lang.String version)
void	writeStartElement(java.lang.String localName)
void	writeStartElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)

Methods inherited from class javanet.staxutils.helpers.StreamWriterDelegate

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IndentingXMLStreamWriter

public IndentingXMLStreamWriter(javax.xml.stream.XMLStreamWriter out)

Method Detail

setIndent

public void setIndent(java.lang.String indent)

Description copied from interface: Indentation

Set the characters used for one level of indentation. The default is Indentation.DEFAULT_INDENT. "\t" is a popular alternative.

Specified by:

setIndent in interface Indentation

getIndent

public java.lang.String getIndent()

Description copied from interface: Indentation

The characters used for one level of indentation.

Specified by:

getIndent in interface Indentation

setNewLine

public void setNewLine(java.lang.String newLine)

Description copied from interface: Indentation

Set the characters that introduce a new line. The default is Indentation.NORMAL_END_OF_LINE. getLineSeparator()() is a popular alternative.

Specified by:

setNewLine in interface Indentation

getLineSeparator

public static java.lang.String getLineSeparator()

Returns:

System.getProperty("line.separator"); or Indentation.NORMAL_END_OF_LINE if that fails.

getNewLine

public java.lang.String getNewLine()

Description copied from interface: Indentation

The characters that introduce a new line.

Specified by:

getNewLine in interface Indentation

writeStartDocument

public void writeStartDocument()
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String version)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String encoding,
                      java.lang.String version)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeDTD

public void writeDTD(java.lang.String dtd)
              throws javax.xml.stream.XMLStreamException

Specified by:

writeDTD in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeDTD in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String target)
                                throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeProcessingInstruction in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String target,
                              java.lang.String data)
                                throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeProcessingInstruction in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeComment

public void writeComment(java.lang.String data)
                  throws javax.xml.stream.XMLStreamException

Specified by:

writeComment in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeComment in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String namespaceURI,
                     java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String prefix,
                     java.lang.String localName,
                     java.lang.String namespaceURI)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String namespaceURI,
                     java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String prefix,
                     java.lang.String localName,
                     java.lang.String namespaceURI)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(java.lang.String text)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCharacters in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
                   int start,
                   int len)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCharacters in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeCData

public void writeCData(java.lang.String data)
                throws javax.xml.stream.XMLStreamException

Specified by:

writeCData in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCData in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEntityRef

public void writeEntityRef(java.lang.String name)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeEntityRef in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEntityRef in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

public void writeEndElement()
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeEndElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEndElement in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws javax.xml.stream.XMLStreamException

Specified by:

writeEndDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEndDocument in class StreamWriterDelegate

Throws:

javax.xml.stream.XMLStreamException

beforeMarkup

protected void beforeMarkup()

Prepare to write markup, by writing a new line and indentation.

afterMarkup

protected void afterMarkup()

Note that markup or indentation was written.

afterData

protected void afterData()

Note that data were written.

beforeStartElement

protected void beforeStartElement()

Prepare to start an element, by allocating stack space.

afterStartElement

protected void afterStartElement()

Note that an element was started.

beforeEndElement

protected void beforeEndElement()

Prepare to end an element, by writing a new line and indentation.

afterEndElement

protected void afterEndElement()

Note that an element was ended.

afterEndDocument

protected void afterEndDocument()

Note that a document was ended.

writeNewLine

protected void writeNewLine(int indentation)
                     throws javax.xml.stream.XMLStreamException

Write a line separator followed by indentation.

Throws:

javax.xml.stream.XMLStreamException