Package org.dellroad.stuff.xml

Class AnnotatedXMLStreamReader

java.lang.Object

javax.xml.stream.util.StreamReaderDelegate

org.dellroad.stuff.xml.AnnotatedXMLStreamReader

All Implemented Interfaces:

XMLStreamConstants, XMLStreamReader

Direct Known Subclasses:

UpdatesXMLStreamReader

public abstract class AnnotatedXMLStreamReader
extends StreamReaderDelegate

XMLStreamReader 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. When the annotation element is encountered, readAnnotationElement() will be invoked.

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

See Also:

• AnnotatedXMLStreamWriter

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor	Description
AnnotatedXMLStreamReader(XMLStreamReader parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	next()
int	nextTag()
protected abstract boolean	readAnnotationElement(XMLStreamReader reader)	Determine if the given XMLStreamReader is positioned at the annotation element, and if so, read it.

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

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getParent, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, require, setParent, standaloneSet

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedXMLStreamReader

public AnnotatedXMLStreamReader(XMLStreamReader parent)

Constructor.

Parameters:

parent - parent reader

Method Details

next

public int next()
         throws XMLStreamException

Specified by:

next in interface XMLStreamReader

Overrides:

next in class StreamReaderDelegate

Throws:

XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException

Specified by:

nextTag in interface XMLStreamReader

Overrides:

nextTag in class StreamReaderDelegate

Throws:

XMLStreamException

readAnnotationElement

protected abstract boolean readAnnotationElement(XMLStreamReader reader)
                                          throws XMLStreamException

Determine if the given XMLStreamReader is positioned at the annotation element, and if so, read it.

When this method is invoked, the reader's current event has type XMLStreamConstants.START_ELEMENT and may represent the start of the annotation element. If it doesn't, this method should not read any events and immediately return false. Otherwise, this method should read subsequent events up through the corresponding XMLStreamConstants.END_ELEMENT event and return true. Upon return, the reader's current event will have type XMLStreamConstants.END_ELEMENT.

Parameters:

reader - source from which the the annotation element is to be read, if found

Returns:

true if the current event is the start of the annotation element and has been read, false otherwise

Throws:

XMLStreamException - if an XML parse error occurs