net.lecousin.framework.xml

Class XMLStreamReaderAsync

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

net.lecousin.framework.xml.XMLStreamEventsAsync

net.lecousin.framework.xml.XMLStreamReaderAsync

public class XMLStreamReaderAsync
extends XMLStreamEventsAsync

Read an XML in a similar way as XMLStreamReader: read-only, forward, event based. The method next() allows to move forward to the next event (such as start element, end element, comment, text...). It uses UnprotectedString to avoid allocating many character arrays. Charset is automatically detected by reading the beginning of the XML (either with auto-detection or with the specified encoding).

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

Field Summary

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

event, maxCDataSize, maxTextSize, stream

Constructor Summary

Constructors

Constructor and Description
XMLStreamReaderAsync(IO.Readable io, Charset defaultEncoding, int charactersBuffersSize, int maxBuffers) Initialize with the given IO.
XMLStreamReaderAsync(IO.Readable io, int charactersBuffersSize, int maxBuffers) Constructor, without charset (automatic detection).

Method Summary

Modifier and Type	Method and Description
byte	getPriority() Return the priority used for tasks.
Async<Exception>	next() Move forward to the next event.
IAsync<Exception>	start() Start reading the XML to provide the first event.
IAsync<Exception>	startRootElement() Shortcut to move forward to the first START_ELEMENT event, skipping the header or comments.

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

Constructor Detail

XMLStreamReaderAsync

public XMLStreamReaderAsync(IO.Readable io,
                            Charset defaultEncoding,
                            int charactersBuffersSize,
                            int maxBuffers)

Initialize with the given IO. If it is not buffered, a PreBufferedReadable is created. If the charset is null, it will be automatically detected.

XMLStreamReaderAsync

public XMLStreamReaderAsync(IO.Readable io,
                            int charactersBuffersSize,
                            int maxBuffers)

Constructor, without charset (automatic detection).

Method Detail

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

getPriority

public byte getPriority()

Description copied from class: XMLStreamEventsAsync

Return the priority used for tasks.

Specified by:

getPriority in class XMLStreamEventsAsync

startRootElement

public IAsync<Exception> startRootElement()

Shortcut to move forward to the first START_ELEMENT event, skipping the header or comments.