net.lecousin.framework.xml

Class XMLStreamEventsRecorder.Async

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

net.lecousin.framework.xml.XMLStreamEventsAsync

net.lecousin.framework.xml.XMLStreamEventsRecorder.Async

All Implemented Interfaces:

XMLStreamEventsRecorder

Enclosing interface:

XMLStreamEventsRecorder

public static class XMLStreamEventsRecorder.Async
extends XMLStreamEventsAsync
implements XMLStreamEventsRecorder

Asynchronous implementation of the recorder.

Nested Class Summary

Nested classes/interfaces inherited from class net.lecousin.framework.xml.XMLStreamEventsAsync

XMLStreamEventsAsync.Next, XMLStreamEventsAsync.ParsingTask

Nested classes/interfaces inherited from class net.lecousin.framework.xml.XMLStreamEvents

XMLStreamEvents.Attribute, XMLStreamEvents.ElementContext, XMLStreamEvents.Event, XMLStreamEvents.Starter

Nested classes/interfaces inherited from interface net.lecousin.framework.xml.XMLStreamEventsRecorder

XMLStreamEventsRecorder.Async, XMLStreamEventsRecorder.Sync

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedList<XMLStreamEvents.Event>	record
protected boolean	recording
protected Iterator<XMLStreamEvents.Event>	replaying
protected XMLStreamEventsAsync	xmlStream

Fields inherited from class net.lecousin.framework.xml.XMLStreamEvents

event, maxCDataSize, maxTextSize, stream

Constructor Summary

Constructors

Constructor and Description
Async(XMLStreamEventsAsync stream) Constructor.

Method Summary

Modifier and Type	Method and Description
XMLStreamEvents.Event	getFirstRecordedEvent() Shortcut to know what is the first recorded event.
byte	getPriority() Return the priority used for tasks.
Async<Exception>	next() Move forward to the next event.
void	replay() Start to replay.
IAsync<Exception>	start() Start reading the XML to provide the first event.
void	startRecording(boolean recordCurrentEvent) Start to record events.
void	stopRecording() Stop recording events.

Methods inherited from class net.lecousin.framework.xml.XMLStreamEventsAsync

check, closeElement, closeElement, goInto, nextInnerElement, nextInnerElement, nextStartElement, readInnerElementsText, readInnerText, searchElement

Methods inherited from class net.lecousin.framework.xml.XMLStreamEvents

getAttributeByFullName, getAttributeByLocalName, getAttributeValueByFullName, getAttributeValueByLocalName, getAttributeValueWithNamespaceURI, getAttributeValueWithPrefix, getAttributeWithNamespaceURI, getAttributeWithPrefix, getCharacterStream, getMaximumCDataSize, getMaximumTextSize, getNamespaceURI, isNameChar, isNameStartChar, isSpaceChar, onStartElement, readNamespaces, removeAttributeByFullName, removeAttributeByLocalName, removeAttributeWithNamespaceURI, removeAttributeWithPrefix, reset, setMaximumCDataSize, setMaximumTextSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xmlStream

protected XMLStreamEventsAsync xmlStream

recording

protected boolean recording

record

protected LinkedList<XMLStreamEvents.Event> record

replaying

protected Iterator<XMLStreamEvents.Event> replaying

Constructor Detail

Async

public Async(XMLStreamEventsAsync stream)

Constructor.

Method Detail

getPriority

public byte getPriority()

Description copied from class: XMLStreamEventsAsync

Return the priority used for tasks.

Specified by:

getPriority in class XMLStreamEventsAsync

getFirstRecordedEvent

public XMLStreamEvents.Event getFirstRecordedEvent()

Description copied from interface: XMLStreamEventsRecorder

Shortcut to know what is the first recorded event.

Specified by:

getFirstRecordedEvent in interface XMLStreamEventsRecorder

start

public IAsync<Exception> start()

Description copied from class: XMLStreamEventsAsync

Start reading the XML to provide the first event. If the first tag is a processing instruction XML it reads it and goes to the next event.

Specified by:

start in class XMLStreamEventsAsync

next

public Async<Exception> next()

Description copied from class: XMLStreamEventsAsync

Move forward to the next event. If the next event can be read synchronously, the result is unblocked, else the caller has to wait for it.

Specified by:

next in class XMLStreamEventsAsync

startRecording

public void startRecording(boolean recordCurrentEvent)

Description copied from interface: XMLStreamEventsRecorder

Start to record events.

Specified by:

startRecording in interface XMLStreamEventsRecorder

Parameters:

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

stopRecording

public void stopRecording()

Description copied from interface: XMLStreamEventsRecorder

Stop recording events.

Specified by:

stopRecording in interface XMLStreamEventsRecorder

replay

public void replay()

Description copied from interface: XMLStreamEventsRecorder

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.

Specified by:

replay in interface XMLStreamEventsRecorder