Package org.dellroad.stuff.xml

Class AnnotatedXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

org.dellroad.stuff.xml.AnnotatedXMLEventReader

All Implemented Interfaces:

Iterator<Object>, XMLEventReader

public abstract class AnnotatedXMLEventReader
extends EventReaderDelegate

XMLEventReader that reads and removes an initial annotation element from an XML document. The annotation element, if present, must be the first element inside the top-level document element. readAnnotationElement() must be provided by the subclass to determine whether the first non-top element is the expected annotation element, and read it if so. Whoever reads from this AnnotatedXMLEventReader instance class will not see the annotation element.

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

See Also:

• AnnotatedXMLEventWriter

Constructor Summary

Constructors

Constructor	Description
AnnotatedXMLEventReader(XMLEventReader parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
Object	next()
XMLEvent	nextEvent()
XMLEvent	peek()
protected abstract boolean	readAnnotationElement(XMLEventReader reader)	Determine if the next event from the given XMLEventReader is the annotation element, and if so, read it.

Methods inherited from class javax.xml.stream.util.EventReaderDelegate

close, getElementText, getParent, getProperty, hasNext, nextTag, remove, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

AnnotatedXMLEventReader

public AnnotatedXMLEventReader(XMLEventReader parent)

Constructor.

Parameters:

parent - parent reader

Method Details

next

public Object next()

Specified by:

next in interface Iterator<Object>

Overrides:

next in class EventReaderDelegate

peek

public XMLEvent peek()
              throws XMLStreamException

Specified by:

peek in interface XMLEventReader

Overrides:

peek in class EventReaderDelegate

Throws:

XMLStreamException

nextEvent

public XMLEvent nextEvent()
                   throws XMLStreamException

Specified by:

nextEvent in interface XMLEventReader

Overrides:

nextEvent in class EventReaderDelegate

Throws:

XMLStreamException

readAnnotationElement

protected abstract boolean readAnnotationElement(XMLEventReader reader)
                                          throws XMLStreamException

Determine if the next event from the given XMLEventReader is the annotation element, and if so, read it.

This method should invoke reader.peek() to determine if the next event is the annotation StartElement; if it's not, this method should not read any events and immediately return false. Otherwise, it should read the annotation StartElement and all subsequent events up through the matching EndElement and return true.

Parameters:

reader - source from which the rest of the annotation element is to be read

Returns:

false if the annotation element is not seen, true if seen and fully read

Throws:

XMLStreamException - if a parsing error occurs