net.lecousin.framework.xml

Interface XMLStreamEventsRecorder

All Known Implementing Classes:

XMLStreamEventsRecorder.Async, XMLStreamEventsRecorder.Sync

public interface XMLStreamEventsRecorder

An XMLStreamEventsRecorder allows to wrap an XMLStreamEvents, record each events, and be able to replay them. Because an XMLStreamEvents goes always forward, it may be sometimes useful to be able to replay those events, either on the full XML document, or on a sub-part.
Both synchronous and asynchronous implementations are available as inner classes of this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XMLStreamEventsRecorder.Async Asynchronous implementation of the recorder.
static class	XMLStreamEventsRecorder.Sync Synchronous implementation of the recorder.

Method Summary

Modifier and Type	Method and Description
XMLStreamEvents.Event	getFirstRecordedEvent() Shortcut to know what is the first recorded event.
void	replay() Start to replay.
void	startRecording(boolean recordCurrentEvent) Start to record events.
void	stopRecording() Stop recording events.

Method Detail

startRecording

void startRecording(boolean recordCurrentEvent)

Start to record events.

Parameters:

recordCurrentEvent - true to save the current event, false to start saving events for the next one.

stopRecording

void stopRecording()

Stop recording events.

replay

void replay()

Start to replay. Once this method is called, when reaching the last recorded event an EOFException will be raised. This method may be called multiple times to replay several times the recorded events. It will restart from the first recorded event at each call.

getFirstRecordedEvent

XMLStreamEvents.Event getFirstRecordedEvent()

Shortcut to know what is the first recorded event.