public interface

XMLEventReader

implements Iterator<E>
javax.xml.stream.XMLEventReader
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract void close()
Frees any resources associated with this Reader.
abstract String getElementText()
Reads the content of a text-only element.
abstract Object getProperty(String name)
Get the value of a feature/property from the underlying implementation
abstract boolean hasNext()
Check if there are more events.
abstract XMLEvent nextEvent()
Get the next XMLEvent
abstract XMLEvent nextTag()
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
abstract XMLEvent peek()
Check the next XMLEvent without reading it from the stream.
[Expand]
Inherited Methods
From interface java.util.Iterator

Public Methods

public abstract void close ()

Frees any resources associated with this Reader. This method does not close the underlying input source.

Throws
XMLStreamException if there are errors freeing associated resources

public abstract String getElementText ()

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

public abstract Object getProperty (String name)

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
IllegalArgumentException if the property is not supported

public abstract boolean hasNext ()

Check if there are more events. Returns true if there are more events and false otherwise.

Returns
  • true if the event reader has more events, false otherwise

public abstract XMLEvent nextEvent ()

Get the next XMLEvent

Throws
XMLStreamException if there is an error with the underlying XML.
iteration has no more elements.
See Also

public abstract XMLEvent nextTag ()

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

public abstract XMLEvent peek ()

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