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

• java.lang.Object

• • javax.xml.stream.util.EventReaderDelegate

• All Implemented Interfaces:
  Iterator, XMLEventReader

public class EventReaderDelegate
extends Object
implements XMLEventReader
This is the base class for deriving an XMLEventReader filter. This class is designed to sit between an XMLEventReader and an application's XMLEventReader. By default each method does nothing but call the corresponding method on the parent interface.
Since:
1.6
Version:
1.0
See Also:
XMLEventReader, StreamReaderDelegate

• • Constructor Summary

  Constructors

  Constructor	Description
  EventReaderDelegate()	Construct an empty filter with no parent.
  EventReaderDelegate(XMLEventReader reader)	Construct an filter with the specified parent.

  • Method Summary

  All Methods Instance Methods Concrete 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.
  XMLEventReader	getParent()	Get the parent of this instance.
  Object	getProperty(String name)	Get the value of a feature/property from the underlying implementation
  boolean	hasNext()	Check if there are more events.
  Object	next()	Returns the next element in the iteration.
  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.
  void	remove()	Removes from the underlying collection the last element returned by this iterator (optional operation).
  void	setParent(XMLEventReader reader)	Set the parent of this instance.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`  
     * ### 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-)`

• • Constructor Detail

     * #### EventReaderDelegate  
     public EventReaderDelegate()  
     Construct an empty filter with no parent.  
     * #### EventReaderDelegate  
     public EventReaderDelegate([XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream") reader)  
     Construct an filter with the specified parent.  
     Parameters:  
     `reader` \- the parent  

  • Method Detail

    * #### setParent  
    public void setParent([XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream") reader)  
    Set the parent of this instance.  
    Parameters:  
    `reader` \- the new parent  
    * #### getParent  
    public [XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream") getParent()  
    Get the parent of this instance.  
    Returns:  
    the parent or null if none is set  
    * #### nextEvent  
    public [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  
    Specified by:  
    `[nextEvent](../../../../javax/xml/stream/XMLEventReader.html#nextEvent--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    Throws:  
    `[XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if there is an error with the underlying XML.  
    See Also:  
    [XMLEvent](../../../../javax/xml/stream/events/XMLEvent.html "interface in javax.xml.stream.events")  
    * #### next  
    public [Object](../../../../java/lang/Object.html "class in java.lang") next()  
    Description copied from interface: `[Iterator](../../../../java/util/Iterator.html#next--)`  
    Returns the next element in the iteration.  
    Specified by:  
    `[next](../../../../java/util/Iterator.html#next--)` in interface `[Iterator](../../../../java/util/Iterator.html "interface in java.util")`  
    Returns:  
    the next element in the iteration  
    * #### hasNext  
    public 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")`  
    Specified by:  
    `[hasNext](../../../../javax/xml/stream/XMLEventReader.html#hasNext--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    Returns:  
    true if the event reader has more events, false otherwise  
    * #### peek  
    public [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().  
    Specified by:  
    `[peek](../../../../javax/xml/stream/XMLEventReader.html#peek--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    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")  
    * #### close  
    public 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.  
    Specified by:  
    `[close](../../../../javax/xml/stream/XMLEventReader.html#close--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    Throws:  
    `[XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if there are errors freeing associated resources  
    * #### getElementText  
    public [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.  
    Specified by:  
    `[getElementText](../../../../javax/xml/stream/XMLEventReader.html#getElementText--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    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  
    public [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.  
    Specified by:  
    `[nextTag](../../../../javax/xml/stream/XMLEventReader.html#nextTag--)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    Throws:  
    `[XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if anything other than space characters are encountered  
    * #### getProperty  
    public [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  
    Specified by:  
    `[getProperty](../../../../javax/xml/stream/XMLEventReader.html#getProperty-java.lang.String-)` in interface `[XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream")`  
    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  
    * #### remove  
    public void remove()  
    Description copied from interface: `[Iterator](../../../../java/util/Iterator.html#remove--)`  
    Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to [Iterator.next()](../../../../java/util/Iterator.html#next--). The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.  
    Specified by:  
    `[remove](../../../../java/util/Iterator.html#remove--)` in interface `[Iterator](../../../../java/util/Iterator.html "interface in java.util")`

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.