Package org.dellroad.stuff.xml

Class StackXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

org.dellroad.stuff.xml.StackXMLEventReader

All Implemented Interfaces:

Iterator<Object>, XMLEventReader

public class StackXMLEventReader
extends EventReaderDelegate

Wrapper for a XMLEventReader that keeps track of the current element(s) being parsed as a stack of StartElement events.

Each time a StartElement is read from the underlying XMLEventReader, it is pushed onto the stack; each time a EndElement is read from the underlying XMLEventReader, the previously push StartElement is popped off.

Invocations of EventReaderDelegate.peek() do not affect the element stack.

If an XMLStreamException is thrown at any point, the element stack is no longer guaranteed to track properly.

Constructor Summary

Constructors

Constructor	Description
StackXMLEventReader(XMLEventReader reader)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected XMLEvent	adjust(XMLEvent event)	Adjust the stack after reading the given event.
List<StartElement>	getElementStack()	Get the entire stack of StartElements.
String	getElementText()
StartElement	getTopElement()	Get the top-most StartElement event on the stack.
Object	next()
XMLEvent	nextEvent()
XMLEvent	nextTag()

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

close, getParent, getProperty, hasNext, peek, 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

StackXMLEventReader

public StackXMLEventReader(XMLEventReader reader)

Constructor.

Parameters:

reader - underlying reader

Throws:

IllegalArgumentException - if reader is null

Method Details

getTopElement

public StartElement getTopElement()

Get the top-most StartElement event on the stack. This corresponds to the innermost XML element currently being read.

Returns:

current element, or null if the current parse position is outside of the document element

getElementStack

public List<StartElement> getElementStack()

Get the entire stack of StartElements.

A copy is returned; changes to the returned list do not affect this instance.

Returns:

element stack; the first element in the list is the document element

getElementText

public String getElementText()
                      throws XMLStreamException

Specified by:

getElementText in interface XMLEventReader

Overrides:

getElementText in class EventReaderDelegate

Throws:

XMLStreamException

next

public Object next()

Specified by:

next in interface Iterator<Object>

Overrides:

next in class EventReaderDelegate

nextEvent

public XMLEvent nextEvent()
                   throws XMLStreamException

Specified by:

nextEvent in interface XMLEventReader

Overrides:

nextEvent in class EventReaderDelegate

Throws:

XMLStreamException

nextTag

public XMLEvent nextTag()
                 throws XMLStreamException

Specified by:

nextTag in interface XMLEventReader

Overrides:

nextTag in class EventReaderDelegate

Throws:

XMLStreamException

adjust

protected XMLEvent adjust(XMLEvent event)

Adjust the stack after reading the given event.

Parameters:

event - newly read event

Returns:

event