Package org.dellroad.stuff.xml

Class IndentXMLEventWriter

java.lang.Object

org.dellroad.stuff.xml.EventWriterDelegate

org.dellroad.stuff.xml.IndentXMLEventWriter

All Implemented Interfaces:

XMLEventConsumer, XMLEventWriter

public class IndentXMLEventWriter
extends EventWriterDelegate

Wrapper for an underlying XMLEventWriter that automatically adds indentation to the event stream.

Field Summary

Fields

Modifier and Type	Field	Description
protected final XMLEventFactory	factory	The configured event factory for this instance.

Constructor Summary

Constructors

Constructor	Description
IndentXMLEventWriter(XMLEventWriter writer, int indent)	Convenience constructor.
IndentXMLEventWriter(XMLEventWriter writer, XMLEventFactory factory, int indent)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(XMLEvent event)
void	add(XMLEventReader reader)
protected void	indent(int depth)	Emit a newline followed by indentation to the given depth.

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

close, flush, getNamespaceContext, getParent, getPrefix, setDefaultNamespace, setNamespaceContext, setParent, setPrefix

Methods inherited from class java.lang.Object

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

Field Details

factory

protected final XMLEventFactory factory

The configured event factory for this instance.

Constructor Details

IndentXMLEventWriter

public IndentXMLEventWriter(XMLEventWriter writer,
 XMLEventFactory factory,
 int indent)

Constructor.

Parameters:

writer - underlying writer

factory - event factory

indent - indent amount, or negative to not add any whitespace

Throws:

IllegalArgumentException - if writer or factory is null

IndentXMLEventWriter

public IndentXMLEventWriter(XMLEventWriter writer,
 int indent)

Convenience constructor. Equivalent to:

IndentXMLEventWriter(writer, XMLEventFactory.newFactory(), indent)

Parameters:

writer - underlying writer

indent - indent amount, or negative to not add any whitespace

Throws:

IllegalArgumentException - if writer or factory is null

Method Details

add

public void add(XMLEvent event)
         throws XMLStreamException

Specified by:

add in interface XMLEventConsumer

Specified by:

add in interface XMLEventWriter

Overrides:

add in class EventWriterDelegate

Throws:

XMLStreamException

add

public void add(XMLEventReader reader)
         throws XMLStreamException

Specified by:

add in interface XMLEventWriter

Overrides:

add in class EventWriterDelegate

Throws:

XMLStreamException

indent

protected void indent(int depth)
               throws XMLStreamException

Emit a newline followed by indentation to the given depth.

Parameters:

depth - indentation depth

Throws:

XMLStreamException - if an XML error occurs