Package org.dellroad.stuff.xml

Class AnnotatedXMLStreamWriter

java.lang.Object

org.dellroad.stuff.xml.StreamWriterDelegate

org.dellroad.stuff.xml.AnnotatedXMLStreamWriter

All Implemented Interfaces:

XMLStreamWriter

Direct Known Subclasses:

UpdatesXMLStreamWriter

public abstract class AnnotatedXMLStreamWriter
extends StreamWriterDelegate

XMLStreamWriter 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 AnnotatedXMLStreamReader to transparently annotate XML documents.

See Also:

• AnnotatedXMLStreamReader

Constructor Summary

Constructors

Constructor	Description
AnnotatedXMLStreamWriter(XMLStreamWriter parent)

Method Summary

Modifier and Type	Method	Description
protected abstract void	addAnnotationElement(XMLStreamWriter writer)	Add the annotation element.
protected String	getTrailingSpace()	Get the whitespace found between the opening document tag and the first non-space child.
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	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, writeStartDocument, writeStartDocument, writeStartDocument

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedXMLStreamWriter

public AnnotatedXMLStreamWriter(XMLStreamWriter parent)

Method Details

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

getTrailingSpace

protected String getTrailingSpace()

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

Returns:

whitespace after document tag

addAnnotationElement

protected abstract void addAnnotationElement(XMLStreamWriter writer)
                                      throws XMLStreamException

Add the annotation element.

This method should write the start element, followed by by any nested content, and then lastly the end element for the annotation element.

Parameters:

writer - output to which the annotation element should be written

Throws:

XMLStreamException - if an XML error occurs