org.hibernate.boot.jaxb.internal.stax

Class BaseXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

org.hibernate.boot.jaxb.internal.stax.BaseXMLEventReader

All Implemented Interfaces:

java.util.Iterator, javax.xml.stream.XMLEventReader

Direct Known Subclasses:

BufferedXMLEventReader, FilteringXMLEventReader

public abstract class BaseXMLEventReader
extends javax.xml.stream.util.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

Constructor Summary

Constructors

Constructor and Description
BaseXMLEventReader(javax.xml.stream.XMLEventReader reader)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementText()
protected javax.xml.stream.events.XMLEvent	getPreviousEvent()
protected abstract javax.xml.stream.events.XMLEvent	internalNextEvent() Subclass's version of nextEvent(), called by next()
java.lang.Object	next()
javax.xml.stream.events.XMLEvent	nextEvent()
javax.xml.stream.events.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(javax.xml.stream.XMLEventReader reader)

Method Detail

internalNextEvent

protected abstract javax.xml.stream.events.XMLEvent internalNextEvent()
                                                               throws javax.xml.stream.XMLStreamException

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

Throws:

javax.xml.stream.XMLStreamException

getPreviousEvent

protected final javax.xml.stream.events.XMLEvent getPreviousEvent()

Returns:

The XMLEvent returned by the last call to internalNextEvent()

nextEvent

public final javax.xml.stream.events.XMLEvent nextEvent()
                                                 throws javax.xml.stream.XMLStreamException

Specified by:

nextEvent in interface javax.xml.stream.XMLEventReader

Overrides:

nextEvent in class javax.xml.stream.util.EventReaderDelegate

Throws:

javax.xml.stream.XMLStreamException

next

public final java.lang.Object next()

Specified by:

next in interface java.util.Iterator

Overrides:

next in class javax.xml.stream.util.EventReaderDelegate

getElementText

public final java.lang.String getElementText()
                                      throws javax.xml.stream.XMLStreamException

Specified by:

getElementText in interface javax.xml.stream.XMLEventReader

Overrides:

getElementText in class javax.xml.stream.util.EventReaderDelegate

Throws:

javax.xml.stream.XMLStreamException

nextTag

public final javax.xml.stream.events.XMLEvent nextTag()
                                               throws javax.xml.stream.XMLStreamException

Specified by:

nextTag in interface javax.xml.stream.XMLEventReader

Overrides:

nextTag in class javax.xml.stream.util.EventReaderDelegate

Throws:

javax.xml.stream.XMLStreamException