Package org.dellroad.stuff.pobj

Class UpdatesXMLStreamWriter

java.lang.Object

org.dellroad.stuff.xml.StreamWriterDelegate

org.dellroad.stuff.xml.AnnotatedXMLStreamWriter

org.dellroad.stuff.pobj.UpdatesXMLStreamWriter

All Implemented Interfaces:

XMLStreamWriter

public class UpdatesXMLStreamWriter
extends AnnotatedXMLStreamWriter

AnnotatedXMLStreamWriter that inserts the schema update list into the document using an PersistentObjectSchemaUpdater.UPDATES_ELEMENT_NAME annotation element. Used by PersistentObjectSchemaUpdater.

Constructor Summary

Constructors

Constructor	Description
UpdatesXMLStreamWriter(XMLStreamWriter inner, List<String> updates)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addAnnotationElement(XMLStreamWriter writer)	Add the annotation element.

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

getTrailingSpace, writeCData, writeCharacters, writeCharacters, writeComment, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEndElement, writeEntityRef, writeProcessingInstruction, writeProcessingInstruction, writeStartElement, writeStartElement, writeStartElement

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

UpdatesXMLStreamWriter

public UpdatesXMLStreamWriter(XMLStreamWriter inner,
 List<String> updates)

Constructor.

Parameters:

inner - nested output

updates - list of updates to add

Throws:

IllegalArgumentException - if updates is null

Method Details

addAnnotationElement

protected void addAnnotationElement(XMLStreamWriter writer)
                             throws XMLStreamException

Description copied from class: AnnotatedXMLStreamWriter

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.

Specified by:

addAnnotationElement in class AnnotatedXMLStreamWriter

Parameters:

writer - output to which the annotation element should be written

Throws:

XMLStreamException - if an XML error occurs