org.hibernate.internal.util.xml

Class BufferedXMLEventReader

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

org.hibernate.internal.util.xml.BaseXMLEventReader

org.hibernate.internal.util.xml.BufferedXMLEventReader

All Implemented Interfaces:

Iterator, XMLEventReader

public class BufferedXMLEventReader
extends BaseXMLEventReader

Buffers XML events for later re-reading 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/BufferedXMLEventReader.java

Author:

Eric Dalquist

Constructor Summary

Constructors

Constructor and Description
BufferedXMLEventReader(XMLEventReader reader) Create new buffering reader, no buffering is done until mark(int) is called.
BufferedXMLEventReader(XMLEventReader reader, int eventLimit) Create new buffering reader.

Method Summary

Modifier and Type	Method and Description
int	bufferSize()
void	close()
List<XMLEvent>	getBuffer()
boolean	hasNext()
protected XMLEvent	internalNextEvent() Subclass's version of BaseXMLEventReader.nextEvent(), called by BaseXMLEventReader.next()
void	mark() Same as calling mark(int) with -1.
void	mark(int eventLimit) Start buffering events
XMLEvent	peek()
void	remove() If reading from the buffer after a reset() call an IllegalStateException will be thrown.
void	reset() Reset the reader to these start of the buffered events.

Methods inherited from class org.hibernate.internal.util.xml.BaseXMLEventReader

getElementText, getPreviousEvent, next, nextEvent, nextTag

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

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

BufferedXMLEventReader

public BufferedXMLEventReader(XMLEventReader reader)

Create new buffering reader, no buffering is done until mark(int) is called.

BufferedXMLEventReader

public BufferedXMLEventReader(XMLEventReader reader,
                              int eventLimit)

Create new buffering reader. Calls mark(int) with the specified event limit

See Also:

mark(int)

Method Detail

getBuffer

public List<XMLEvent> getBuffer()

Returns:

A copy of the current buffer

internalNextEvent

protected 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

Specified by:

hasNext in interface XMLEventReader

Overrides:

hasNext in class EventReaderDelegate

peek

public XMLEvent peek()
              throws XMLStreamException

Specified by:

peek in interface XMLEventReader

Overrides:

peek in class EventReaderDelegate

Throws:

XMLStreamException

mark

public void mark()

Same as calling mark(int) with -1.

mark

public void mark(int eventLimit)

Start buffering events

Parameters:

eventLimit - the maximum number of events to buffer. -1 will buffer all events, 0 will buffer no events.

reset

public void reset()

Reset the reader to these start of the buffered events.

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLEventReader

Overrides:

close in class EventReaderDelegate

Throws:

XMLStreamException

bufferSize

public int bufferSize()

Returns:

The number of events in the buffer.

remove

public void remove()

If reading from the buffer after a reset() call an IllegalStateException will be thrown.

Specified by:

remove in interface Iterator

Overrides:

remove in class EventReaderDelegate