net.lecousin.framework.xml

Class XMLStreamReader

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

net.lecousin.framework.xml.XMLStreamEventsSync

net.lecousin.framework.xml.XMLStreamReader

public class XMLStreamReader
extends XMLStreamEventsSync

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.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
XMLStreamReader(IO.Readable io, Charset defaultEncoding, int charactersBuffersSize, int maxBuffers) Initialize with the given IO.
XMLStreamReader(IO.Readable io, int charactersBuffersSize, int maxBuffers) Constructor, without charset.

Method Summary

Modifier and Type	Method and Description
void	next() Move forward to the next event.
void	start() Start reading the XML to provide the first event.
static AsyncSupplier<XMLStreamReader,Exception>	start(IO.Readable.Buffered io, int charactersBufferSize, int maxBuffers, boolean addPositionInErrors) Utility method that initialize a XMLStreamReader, initialize it, and return an AsyncWork which is unblocked when characters are available to be read.
void	startRootElement() Shortcut to move forward to the first START_ELEMENT event, skipping the header or comments.

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

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

XMLStreamReader

public XMLStreamReader(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.

XMLStreamReader

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

Constructor, without charset.

Method Detail

start

public static AsyncSupplier<XMLStreamReader,Exception> start(IO.Readable.Buffered io,
                                                             int charactersBufferSize,
                                                             int maxBuffers,
                                                             boolean addPositionInErrors)

Utility method that initialize a XMLStreamReader, initialize it, and return an AsyncWork which is unblocked when characters are available to be read.

start

public void start()
           throws XMLException,
                  IOException

Description copied from class: XMLStreamEventsSync

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 XMLStreamEventsSync

Throws:

XMLException

IOException

next

public void next()
          throws XMLException,
                 IOException

Move forward to the next event.

Specified by:

next in class XMLStreamEventsSync

Throws:

XMLException

IOException

startRootElement

public void startRootElement()
                      throws XMLException,
                             IOException

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

Throws:

XMLException

IOException