javanet.staxutils

Class IndentingXMLEventWriter

java.lang.Object

javanet.staxutils.helpers.EventWriterDelegate

javanet.staxutils.IndentingXMLEventWriter

All Implemented Interfaces:

Indentation, javax.xml.stream.util.XMLEventConsumer, javax.xml.stream.XMLEventWriter

public class IndentingXMLEventWriter
extends EventWriterDelegate
implements Indentation

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

 XMLEventWriter stream = ...
 stream = new IndentingXMLEventWriter(stream);
 stream.add(...);
 

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:

Kohsuke Kawaguchi, John Kristian

Field Summary

Fields inherited from class javanet.staxutils.helpers.EventWriterDelegate

out

Fields inherited from interface javanet.staxutils.Indentation

DEFAULT_INDENT, NORMAL_END_OF_LINE

Constructor Summary

Constructors

Constructor and Description
IndentingXMLEventWriter(javax.xml.stream.XMLEventWriter out)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(javax.xml.stream.events.XMLEvent event)
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.

Methods inherited from class javanet.staxutils.helpers.EventWriterDelegate

add, close, flush, getNamespaceContext, getPrefix, setDefaultNamespace, setNamespaceContext, setPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

IndentingXMLEventWriter

public IndentingXMLEventWriter(javax.xml.stream.XMLEventWriter 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

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. IndentingXMLStreamWriter.getLineSeparator()() is a popular alternative.

Specified by:

setNewLine 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

getNewLine

public java.lang.String getNewLine()

Description copied from interface: Indentation

The characters that introduce a new line.

Specified by:

getNewLine in interface Indentation

getLineSeparator

public static java.lang.String getLineSeparator()

Returns:

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

add

public void add(javax.xml.stream.events.XMLEvent event)
         throws javax.xml.stream.XMLStreamException

Specified by:

add in interface javax.xml.stream.util.XMLEventConsumer

Specified by:

add in interface javax.xml.stream.XMLEventWriter

Overrides:

add in class EventWriterDelegate

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.