Package org.dellroad.stuff.xml

Class AnnotatedXMLEventWriter

java.lang.Object

org.dellroad.stuff.xml.EventWriterDelegate

org.dellroad.stuff.xml.AnnotatedXMLEventWriter

All Implemented Interfaces:

XMLEventConsumer, XMLEventWriter

public abstract class AnnotatedXMLEventWriter
extends EventWriterDelegate

XMLEventWriter that adds an extra annotation element to an XML document as it is written. The annotation element will be added as the first element inside the top-level document element.

This class can be used in combination with AnnotatedXMLEventReader to transparently annotate XML documents.

See Also:

• AnnotatedXMLEventReader

Field Summary

Fields

Modifier and Type	Field	Description
protected final XMLEventFactory	xmlEventFactory

Constructor Summary

Constructors

Constructor	Description
AnnotatedXMLEventWriter(XMLEventWriter inner)

Method Summary

Modifier and Type	Method	Description
void	add(XMLEvent event)
void	add(XMLEventReader reader)
protected abstract void	addAnnotationElement(XMLEventWriter writer)	Add the annotation element.
protected String	getTrailingSpace()	Get the whitespace found between the opening document tag and the first non-space child.

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

xmlEventFactory

protected final XMLEventFactory xmlEventFactory

Constructor Details

AnnotatedXMLEventWriter

public AnnotatedXMLEventWriter(XMLEventWriter inner)

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

getTrailingSpace

protected String getTrailingSpace()

Get the whitespace found between the opening document tag and the first non-space child.

Returns:

initial whitespace

addAnnotationElement

protected abstract void addAnnotationElement(XMLEventWriter writer)
                                      throws XMLStreamException

Add the annotation element.

This method should add() the StartElement for the annotation element, followed by any nested content, and then lastly the EndElement for the annotation element.

Parameters:

writer - output to which the annotation element should be written

Throws:

XMLStreamException - if an XML error occurs