- All Known Implementing Classes:
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.
Modifier and Type Method Description
close()Frees any resources associated with this Reader.
getElementText()Reads the content of a text-only element.
getProperty(String name)Get the value of a feature/property from the underlying implementation
hasNext()Check if there are more events.
nextEvent()Gets the next XMLEvent.
nextTag()Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
peek()Check the next XMLEvent without reading it from the stream.
nextEventGets the next XMLEvent. The initial event is
hasNextboolean hasNext()Check if there are more events. Returns true if there are more events and false otherwise.
peekCheck 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().
getElementTextReads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.
- the text of the element
XMLStreamException- if the current event is not a START_ELEMENT or if a non text element is encountered
nextTagSkips 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.
- a START_ELEMENT or END_ELEMENT
XMLStreamException- if anything other than space characters are encountered
getPropertyGet the value of a feature/property from the underlying implementation
name- The name of the property
- The value of the property
IllegalArgumentException- if the property is not supported
closevoid close() throws XMLStreamExceptionFrees any resources associated with this Reader. This method does not close the underlying input source.
XMLStreamException- if there are errors freeing associated resources