javax.xml.stream.util

Class EventReaderDelegate

java.lang.Object

javax.xml.stream.util.EventReaderDelegate

All Implemented Interfaces:

java.util.Iterator, javax.xml.stream.XMLEventReader

public class EventReaderDelegate
extends java.lang.Object
implements javax.xml.stream.XMLEventReader

Base class for event reader filters.

Constructor Summary

Constructors

Constructor and Description
EventReaderDelegate() Constructs an empty filter with no parent set.
EventReaderDelegate(javax.xml.stream.XMLEventReader reader) Constructs an empty filter with the given parent.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Free any resources associated with this parser.
java.lang.String	getElementText() Reads the text context of an element.
javax.xml.stream.XMLEventReader	getParent() Returns the parent.
java.lang.Object	getProperty(java.lang.String name) Returns the implementation-specific feature or property of the given name.
boolean	hasNext() Indicates whether there are more XML events to be read.
java.lang.Object	next() Obtain the next element in the collection.
javax.xml.stream.events.XMLEvent	nextEvent() Returns the next XML event.
javax.xml.stream.events.XMLEvent	nextTag() Returns the next element event.
javax.xml.stream.events.XMLEvent	peek() Looks at the next XML event without advancing the cursor in the stream.
void	remove() Remove from the underlying collection the last element returned by next (optional operation).
void	setParent(javax.xml.stream.XMLEventReader reader) Sets the parent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventReaderDelegate

public EventReaderDelegate()

Constructs an empty filter with no parent set.

EventReaderDelegate

public EventReaderDelegate(javax.xml.stream.XMLEventReader reader)

Constructs an empty filter with the given parent.

Method Detail

setParent

public void setParent(javax.xml.stream.XMLEventReader reader)

Sets the parent.

getParent

public javax.xml.stream.XMLEventReader getParent()

Returns the parent.

nextEvent

public javax.xml.stream.events.XMLEvent nextEvent()
                                           throws javax.xml.stream.XMLStreamException

Description copied from interface: javax.xml.stream.XMLEventReader

Returns the next XML event.

Specified by:

nextEvent in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

next

public java.lang.Object next()

Description copied from interface: java.util.Iterator

Obtain the next element in the collection.

Specified by:

next in interface java.util.Iterator

Returns:

the next element in the collection

hasNext

public boolean hasNext()

Description copied from interface: javax.xml.stream.XMLEventReader

Indicates whether there are more XML events to be read.

Specified by:

hasNext in interface java.util.Iterator

Specified by:

hasNext in interface javax.xml.stream.XMLEventReader

Returns:

true if there is at least one more element in the collection

peek

public javax.xml.stream.events.XMLEvent peek()
                                      throws javax.xml.stream.XMLStreamException

Description copied from interface: javax.xml.stream.XMLEventReader

Looks at the next XML event without advancing the cursor in the stream. Returns null if there are no more events to read.

Specified by:

peek in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

getElementText

public java.lang.String getElementText()
                                throws javax.xml.stream.XMLStreamException

Description copied from interface: javax.xml.stream.XMLEventReader

Reads the text context of an element. When invoked, the current event must be START_ELEMENT. On completion, the current event will be END_ELEMENT.

Specified by:

getElementText in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

nextTag

public javax.xml.stream.events.XMLEvent nextTag()
                                         throws javax.xml.stream.XMLStreamException

Description copied from interface: javax.xml.stream.XMLEventReader

Returns the next element event. This method skips insignificant space until a START_ELEMENT or END_ELEMENT event is found.

Specified by:

nextTag in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException - if an event that was not an insignificant space event was encountered

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Description copied from interface: javax.xml.stream.XMLEventReader

Returns the implementation-specific feature or property of the given name.

Specified by:

getProperty in interface javax.xml.stream.XMLEventReader

Throws:

java.lang.IllegalArgumentException - if the property is not supported

close

public void close()
           throws javax.xml.stream.XMLStreamException

Description copied from interface: javax.xml.stream.XMLEventReader

Free any resources associated with this parser. This method will not close the underlying input source.

Specified by:

close in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

remove

public void remove()

Description copied from interface: java.util.Iterator

Remove from the underlying collection the last element returned by next (optional operation). This method can be called only once after each call to next(). It does not affect what will be returned by subsequent calls to next.

Specified by:

remove in interface java.util.Iterator