org.hibernate.internal.util.xml

Class BaseXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

org.hibernate.internal.util.xml.BaseXMLEventReader

All Implemented Interfaces:

Iterator, XMLEventReader

Direct Known Subclasses:

BufferedXMLEventReader, FilteringXMLEventReader

public abstract class BaseXMLEventReader
extends EventReaderDelegate

Base for XMLEventReader that implements the getElementText() and nextTag() APIs in a way that is agnostic from the rest of the XMLEventReader implementation. Both will use the subclasses internalNextEvent() as the exclusive way to read events. Note, copied from the uPortal project by permission of author. See https://github.com/Jasig/uPortal/blob/master/uportal-war/src/main/java/org/jasig/portal/xml/stream/BaseXMLEventReader.java

Author:

Eric Dalquist

Constructor Summary

Constructors

Constructor and Description
BaseXMLEventReader(XMLEventReader reader)

Method Summary

Modifier and Type	Method and Description
String	getElementText()
protected XMLEvent	getPreviousEvent()
protected abstract XMLEvent	internalNextEvent() Subclass's version of nextEvent(), called by next()
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 Detail

BaseXMLEventReader

public BaseXMLEventReader(XMLEventReader reader)

Method Detail

internalNextEvent

protected abstract XMLEvent internalNextEvent()
                                       throws XMLStreamException

Subclass's version of nextEvent(), called by next()

Throws:

XMLStreamException

getPreviousEvent

protected final XMLEvent getPreviousEvent()

Returns:

The XMLEvent returned by the last call to internalNextEvent()

nextEvent

public final XMLEvent nextEvent()
                         throws XMLStreamException

Specified by:

nextEvent in interface XMLEventReader

Overrides:

nextEvent in class EventReaderDelegate

Throws:

XMLStreamException

next

public final Object next()

Specified by:

next in interface Iterator

Overrides:

next in class EventReaderDelegate

getElementText

public final String getElementText()
                            throws XMLStreamException

Specified by:

getElementText in interface XMLEventReader

Overrides:

getElementText in class EventReaderDelegate

Throws:

XMLStreamException

nextTag

public final XMLEvent nextTag()
                       throws XMLStreamException

Specified by:

nextTag in interface XMLEventReader

Overrides:

nextTag in class EventReaderDelegate

Throws:

XMLStreamException