Package org.hibernate.boot.jaxb.internal.stax

Class FilteringXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

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

org.hibernate.boot.jaxb.internal.stax.FilteringXMLEventReader

All Implemented Interfaces:

Iterator<Object>, XMLEventReader

public abstract class FilteringXMLEventReader
extends BaseXMLEventReader

Base class for XMLEventReaders that want to modify or remove events from the reader stream. If a StartElement event is removed the subclass's filterEvent(XMLEvent, boolean) will not see any events until after the matching EndElement event. 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/FilteringXMLEventReader.java

Author:

Eric Dalquist

Constructor Summary

Constructors

Constructor	Description
FilteringXMLEventReader(XMLEventReader reader)

Method Summary

Modifier and Type	Method	Description
protected abstract XMLEvent	filterEvent(XMLEvent event, boolean peek)
boolean	hasNext()
protected final XMLEvent	internalNext(boolean peek)
protected final XMLEvent	internalNextEvent()	Subclass's version of BaseXMLEventReader.nextEvent(), called by BaseXMLEventReader.next()
final XMLEvent	peek()

Methods inherited from class org.hibernate.boot.jaxb.internal.stax.BaseXMLEventReader

getElementText, getPreviousEvent, next, nextEvent, nextTag

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

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

FilteringXMLEventReader

public FilteringXMLEventReader(XMLEventReader reader)

Method Details

internalNextEvent

protected final XMLEvent internalNextEvent()
                                    throws XMLStreamException

Description copied from class: BaseXMLEventReader

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

Specified by:

internalNextEvent in class BaseXMLEventReader

Throws:

XMLStreamException

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Object>

Specified by:

hasNext in interface XMLEventReader

Overrides:

hasNext in class EventReaderDelegate

peek

public final XMLEvent peek()
                    throws XMLStreamException

Specified by:

peek in interface XMLEventReader

Overrides:

peek in class EventReaderDelegate

Throws:

XMLStreamException

internalNext

protected final XMLEvent internalNext(boolean peek)
                               throws XMLStreamException

Throws:

XMLStreamException

filterEvent

protected abstract XMLEvent filterEvent(XMLEvent event,
 boolean peek)

Parameters:

event - The current event

peek - If the event is from a peek() call

Returns:

The event to return, if null is returned the event is dropped from the stream and the next event will be used.