XMLEventReader (Java Platform SE 8 ) (original) (raw)

• All Superinterfaces:
  Iterator
  All Known Implementing Classes:
  EventReaderDelegate

public interface XMLEventReader
extends Iterator
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.
Since:
1.6
Version:
1.0
See Also:
XMLInputFactory, XMLEventWriter

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  void	close()	Frees any resources associated with this Reader.
  String	getElementText()	Reads the content of a text-only element.
  Object	getProperty(String name)	Get the value of a feature/property from the underlying implementation
  boolean	hasNext()	Check if there are more events.
  XMLEvent	nextEvent()	Get the next XMLEvent
  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 java.util.[Iterator](../../../java/util/Iterator.html "interface in java.util")  
     `[forEachRemaining](../../../java/util/Iterator.html#forEachRemaining-java.util.function.Consumer-), [next](../../../java/util/Iterator.html#next--), [remove](../../../java/util/Iterator.html#remove--)`

• • Method Detail

     * #### nextEvent  
     [XMLEvent](../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events") nextEvent()  
                 throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Get the next XMLEvent  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if there is an error with the underlying XML.  
     `NoSuchElementException` \- iteration has no more elements.  
     See Also:  
     [XMLEvent](../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events")  
     * #### hasNext  
     boolean hasNext()  
     Check if there are more events. Returns true if there are more events and false otherwise.  
     Specified by:  
     `[hasNext](../../../java/util/Iterator.html#hasNext--)` in interface `[Iterator](../../../java/util/Iterator.html "interface in java.util")`  
     Returns:  
     true if the event reader has more events, false otherwise  
     * #### peek  
     [XMLEvent](../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events") peek()  
            throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     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](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     See Also:  
     [XMLEvent](../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events")  
     * #### getElementText  
     [String](../../../java/lang/String.html "class in java.lang") getElementText()  
                    throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     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](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if the current event is not a START\_ELEMENT or if a non text element is encountered  
     * #### nextTag  
     [XMLEvent](../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events") nextTag()  
               throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     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](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if anything other than space characters are encountered  
     * #### getProperty  
     [Object](../../../java/lang/Object.html "class in java.lang") getProperty([String](../../../java/lang/String.html "class in java.lang") name)  
                 throws [IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")  
     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](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the property is not supported  
     * #### close  
     void close()  
         throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Frees any resources associated with this Reader. This method does not close the underlying input source.  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if there are errors freeing associated resources

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.