javax.xml.stream
Interface XMLEventReader

All Superinterfaces:

XMLIterator

All Known Implementing Classes:

EventReaderDelegate

public interface XMLEventReader

extends XMLIterator

This is the top level interface for parsing XML Events. It provides the ability to peek at the next event and returns configuration information through the property interface.

See Also:

XMLInputFactory, XMLEventWriter

Method Summary

java.lang.String	getElementText() Reads the content of a text-only element.
java.lang.Object	getProperty(java.lang.String name) Get the value of a feature/property from the underlying implementation
XMLEvent	nextTag() Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
XMLEvent	peek() Check the next XMLEvent without reading it from the stream.

Methods inherited from interface javax.xml.stream.XMLIterator

hasNext, next

Method Detail

peek

public XMLEvent peek()
              throws XMLStreamException

Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents. A call to peek() will be equal to the next return of next().

Throws:

XMLStreamException

See Also:

XMLEvent

getElementText

public java.lang.String getElementText()
                                throws XMLStreamException

Reads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.

Throws:

XMLStreamException - if the current event is not a START_ELEMENT or if a non text element is encountered

nextTag

public XMLEvent nextTag()
                 throws XMLStreamException

Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached. If anything other than space characters are encountered, an exception is thrown. This method should be used when processing element-only content because the parser is not able to recognize ignorable whitespace if the DTD is missing or not interpreted.

Throws:

XMLStreamException - if anything other than space characters are encountered

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Get the value of a feature/property from the underlying implementation

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported