public interface javax.xml.stream
XMLEventReader


Show All Login
Java SE 6
  
Implements: Iterator
Implemented by: EventReaderDelegate
Details
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.
version1.0
since1.6
See also javax.xml.stream.XMLInputFactory, javax.xml.stream.XMLEventWriter

Methods
public void close() throws XMLStreamException Details
Frees any resources associated with this Reader. This method does not close the underlying input source.
ThrowsXMLStreamException: if there are errors freeing associated resources
public boolean hasNext() Details
Check if there are more events. Returns true if there are more events and false otherwise.
returntrue if the event reader has more events, false otherwise
public XMLEvent nextEvent() throws XMLStreamException Details
Get the next XMLEvent
ThrowsXMLStreamException: if there is an error with the underlying XML.
ThrowsNoSuchElementException: iteration has no more elements.
See also javax.xml.stream.events.XMLEvent
public XMLEvent nextTag() throws XMLStreamException Details
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.
ThrowsXMLStreamException: if anything other than space characters are encountered
public XMLEvent peek() throws XMLStreamException Details
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().
ThrowsXMLStreamException:
See also javax.xml.stream.events.XMLEvent

Properties
public String getElementText() throws XMLStreamException Details
Reads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.
ThrowsXMLStreamException: if the current event is not a START_ELEMENT or if a non text element is encountered
public Object getProperty(String name) throws IllegalArgumentException Details
Get the value of a feature/property from the underlying implementation
nameThe name of the property
returnThe value of the property
ThrowsIllegalArgumentException: if the property is not supported