com.envoisolutions.sxc.util
Interface XoXMLStreamReader

All Superinterfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader

All Known Implementing Classes:

XoXMLStreamReaderImpl

public interface XoXMLStreamReader
extends javax.xml.stream.XMLStreamReader

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Method Summary

javax.xml.namespace.QName	getAsQName(java.lang.String val)
java.lang.Iterable<Attribute>	getAttributes() Returns an iterator over the attributes of the current element.
java.lang.Iterable<XoXMLStreamReader>	getChildElements() Returns an iterator over the child elements of the current element.
int	getDepth()
boolean	getElementAsBoolean()
byte	getElementAsByte()
org.w3c.dom.Element	getElementAsDomElement()
double	getElementAsDouble()
float	getElementAsFloat()
int	getElementAsInt()
long	getElementAsLong()
javax.xml.namespace.QName	getElementAsQName()
short	getElementAsShort()
java.lang.String	getElementAsString()
java.lang.Iterable<java.lang.String>	getElementAsXmlList()
java.lang.Iterable<XoXMLStreamReader>	getMixedChildElements()
javax.xml.namespace.QName	getXsiType()
boolean	isXsiNil()
int	nextTagIgnoreAll()

Methods inherited from interface javax.xml.stream.XMLStreamReader

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, next, nextTag, require, standaloneSet

Method Detail

getXsiType

javax.xml.namespace.QName getXsiType()

isXsiNil

boolean isXsiNil()

getDepth

int getDepth()

getElementAsInt

int getElementAsInt()
                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsDouble

double getElementAsDouble()
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsShort

short getElementAsShort()
                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsFloat

float getElementAsFloat()
                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsLong

long getElementAsLong()
                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsBoolean

boolean getElementAsBoolean()
                            throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsByte

byte getElementAsByte()
                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsString

java.lang.String getElementAsString()
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsDomElement

org.w3c.dom.Element getElementAsDomElement()
                                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsQName

javax.xml.namespace.QName getElementAsQName()
                                            throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getAsQName

javax.xml.namespace.QName getAsQName(java.lang.String val)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getElementAsXmlList

java.lang.Iterable<java.lang.String> getElementAsXmlList()
                                                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

nextTagIgnoreAll

int nextTagIgnoreAll()
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getAttributes

java.lang.Iterable<Attribute> getAttributes()

Returns an iterator over the attributes of the current element.

CAUTION: For performance reasons, this iterator returns the same attribute object for each iteration and only the internal state of the attribute object is changed. Therefore, you must be careful to not retain the Attribute insance after calling next() on the iterator.

Returns:

an interator over the attributes on the current element

getChildElements

java.lang.Iterable<XoXMLStreamReader> getChildElements()

Returns an iterator over the child elements of the current element.

CAUTION: For performance reasons, this iterator returns this XoXMLStreamReader for each iteration and only the internal state of the XoXMLStreamReader object is changed. Therefore, you must be careful to not retain the XoXMLStreamReader insance after calling next() on the iterator. CAUTION: The hasNext() method of this iterator advances the stream reader to the next element, so once hasNext has been called all operations on this XoXMLStreamReader will be performed on the nexted child element.

Returns:

an interator over the attributes on the current element

Throws:

RuntimeXMLStreamException - if a XMLStreamException occured while advancing to the first child

getMixedChildElements

java.lang.Iterable<XoXMLStreamReader> getMixedChildElements()