net.lecousin.framework.xml

Class XMLStreamEventsSync

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

net.lecousin.framework.xml.XMLStreamEventsSync

Direct Known Subclasses:

XMLStreamEventsRecorder.Sync, XMLStreamReader

public abstract class XMLStreamEventsSync
extends XMLStreamEvents

Base class for synchronous implementations of XMLStreamEvents.

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
XMLStreamEventsSync()

Method Summary

Modifier and Type	Method and Description
void	closeElement() Go the the END_ELEMENT event corresponding to the current START_ELEMENT (must be called with a current event to START_ELEMENT).
boolean	goInto(XMLStreamEvents.ElementContext rootContext, String... innerElements) Go successively into the given elements.
abstract void	next() Move forward to the next event.
boolean	nextInnerElement(XMLStreamEvents.ElementContext parent) Go to the next inner element.
boolean	nextInnerElement(XMLStreamEvents.ElementContext parent, String childName) Go to the next inner element having the given name.
boolean	nextStartElement() Shortcut to move forward to the next START_ELEMENT, return false if no START_ELEMENT event was found.
Map<String,String>	readInnerElementsText(XMLStreamEvents.ElementContext parent) Read all inner elements with their text, and return a mapping with the element's name as key and inner text as value.
UnprotectedStringBuffer	readInnerText() Read inner text and close element.
boolean	searchElement(String elementName) Move forward until an element with the given name is found (whatever its depth).
abstract void	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

XMLStreamEventsSync

public XMLStreamEventsSync()

Method Detail

start

public abstract void start()
                    throws XMLException,
                           IOException

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.

Throws:

XMLException

IOException

next

public abstract void next()
                   throws XMLException,
                          IOException

Move forward to the next event.

Throws:

XMLException

IOException

nextStartElement

public boolean nextStartElement()
                         throws XMLException,
                                IOException

Shortcut to move forward to the next START_ELEMENT, return false if no START_ELEMENT event was found.

Throws:

XMLException

IOException

nextInnerElement

public boolean nextInnerElement(XMLStreamEvents.ElementContext parent)
                         throws XMLException,
                                IOException

Go to the next inner element. Return true if one is found, false if the closing tag of the parent is found.

Throws:

XMLException

IOException

nextInnerElement

public boolean nextInnerElement(XMLStreamEvents.ElementContext parent,
                                String childName)
                         throws XMLException,
                                IOException

Go to the next inner element having the given name. Return true if one is found, false if the closing tag of the parent is found.

Throws:

XMLException

IOException

readInnerText

public UnprotectedStringBuffer readInnerText()
                                      throws XMLException,
                                             IOException

Read inner text and close element.

Throws:

XMLException

IOException

closeElement

public void closeElement()
                  throws XMLException,
                         IOException

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

Throws:

XMLException

IOException

searchElement

public boolean searchElement(String elementName)
                      throws XMLException,
                             IOException

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

Returns:

true if found, false if the end of file is reached.

Throws:

XMLException

IOException

goInto

public boolean goInto(XMLStreamEvents.ElementContext rootContext,
                      String... innerElements)
               throws IOException,
                      XMLException

Go successively into the given elements.

Throws:

IOException

XMLException

readInnerElementsText

public Map<String,String> readInnerElementsText(XMLStreamEvents.ElementContext parent)
                                         throws IOException,
                                                XMLException

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

Throws:

IOException

XMLException