public class

EventReaderDelegate

extends Object
implements XMLEventReader
java.lang.Object
   ↳ javax.xml.stream.util.EventReaderDelegate

Class Overview

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.

See Also

Summary

Public Constructors
EventReaderDelegate()
Construct an empty filter with no parent.
EventReaderDelegate(XMLEventReader reader)
Construct an filter with the specified parent.
Public Methods
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()
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()
void setParent(XMLEventReader reader)
Set the parent of this instance.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface javax.xml.stream.XMLEventReader

Public Constructors

public EventReaderDelegate ()

Construct an empty filter with no parent.

public EventReaderDelegate (XMLEventReader reader)

Construct an filter with the specified parent.

Parameters
reader the parent

Public Methods

public void close ()

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

Throws
XMLStreamException

public 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

public XMLEventReader getParent ()

Get the parent of this instance.

Returns
  • the parent or null if none is set

public 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

public 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 Object next ()

public XMLEvent nextEvent ()

Get the next XMLEvent

Throws
XMLStreamException

public 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

public 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

public void remove ()

public void setParent (XMLEventReader reader)

Set the parent of this instance.

Parameters
reader the new parent