net.lecousin.framework.xml

Class XMLStreamEventsAsync

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

net.lecousin.framework.xml.XMLStreamEventsAsync

Direct Known Subclasses:

XMLStreamEventsRecorder.Async, XMLStreamReaderAsync

public abstract class XMLStreamEventsAsync
extends XMLStreamEvents

Base class for asynchronous implementations of XMLStreamEvents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XMLStreamEventsAsync.Next Shortcut to create a task going to the next event, and call onNext if an event is successfully found.
protected class	XMLStreamEventsAsync.ParsingTask Shortcut class to create a task.

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

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

Field Summary

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

event, maxCDataSize, maxTextSize, stream

Constructor Summary

Constructors

Constructor and Description
XMLStreamEventsAsync()

Method Summary

Modifier and Type	Method and Description
protected boolean	check(IAsync<Exception> op, IAsync<Exception> result)
IAsync<Exception>	closeElement() Go the the END_ELEMENT event corresponding to the current START_ELEMENT (must be called with a current event to START_ELEMENT).
IAsync<Exception>	closeElement(XMLStreamEvents.ElementContext ctx) Move forward until the closing tag of the given element is found.
abstract byte	getPriority() Return the priority used for tasks.
AsyncSupplier<Boolean,Exception>	goInto(XMLStreamEvents.ElementContext rootContext, String... innerElements) Go successively into the given elements.
abstract Async<Exception>	next() Move forward to the next event.
AsyncSupplier<Boolean,Exception>	nextInnerElement(XMLStreamEvents.ElementContext parent) Go to the next inner element.
AsyncSupplier<Boolean,Exception>	nextInnerElement(XMLStreamEvents.ElementContext parent, String childName) Go to the next inner element having the given name.
IAsync<Exception>	nextStartElement() Shortcut to move forward to the next START_ELEMENT.
AsyncSupplier<Map<String,String>,Exception>	readInnerElementsText() Read all inner elements with their text, and return a mapping with the element's name as key and inner text as value.
AsyncSupplier<UnprotectedStringBuffer,Exception>	readInnerText() Read inner text and close element.
IAsync<Exception>	searchElement(String elementName) Move forward until an element with the given name is found (whatever its depth).
abstract IAsync<Exception>	start() Start reading the XML to provide the first event.

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

Constructor Detail

XMLStreamEventsAsync

public XMLStreamEventsAsync()

Method Detail

start

public abstract IAsync<Exception> start()

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.

getPriority

public abstract byte getPriority()

Return the priority used for tasks.

next

public abstract Async<Exception> next()

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.

nextStartElement

public IAsync<Exception> nextStartElement()

Shortcut to move forward to the next START_ELEMENT.

nextInnerElement

public AsyncSupplier<Boolean,Exception> nextInnerElement(XMLStreamEvents.ElementContext parent)

Go to the next inner element. The result is false if the parent element has been closed.

nextInnerElement

public AsyncSupplier<Boolean,Exception> nextInnerElement(XMLStreamEvents.ElementContext parent,
                                                         String childName)

Go to the next inner element having the given name. The result is false if the parent element has been closed.

check

protected boolean check(IAsync<Exception> op,
                        IAsync<Exception> result)

readInnerText

public AsyncSupplier<UnprotectedStringBuffer,Exception> readInnerText()

Read inner text and close element.

closeElement

public IAsync<Exception> closeElement()

Go the the END_ELEMENT event corresponding to the current START_ELEMENT (must be called with a current event to START_ELEMENT).

closeElement

public IAsync<Exception> closeElement(XMLStreamEvents.ElementContext ctx)

Move forward until the closing tag of the given element is found.

searchElement

public IAsync<Exception> searchElement(String elementName)

Move forward until an element with the given name is found (whatever its depth).

goInto

public AsyncSupplier<Boolean,Exception> goInto(XMLStreamEvents.ElementContext rootContext,
                                               String... innerElements)

Go successively into the given elements.

readInnerElementsText

public AsyncSupplier<Map<String,String>,Exception> readInnerElementsText()

Read all inner elements with their text, and return a mapping with the element's name as key and inner text as value.