javanet.staxutils

Class XMLStreamEventReader

java.lang.Object

javanet.staxutils.XMLStreamEventReader

All Implemented Interfaces:

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

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

XMLEventReader implementation based on a XMLStreamReader and an XMLEventAllocator.

Version:

$Revision: 1.3 $

Author:

Christian Niles

Constructor Summary

Constructors

Constructor and Description
XMLStreamEventReader(javax.xml.stream.XMLStreamReader reader)
XMLStreamEventReader(javax.xml.stream.XMLStreamReader reader, javax.xml.stream.util.XMLEventAllocator allocator)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.xml.stream.events.XMLEvent	allocateEvent() Reads the next event from the underlying reader.
void	close()
java.lang.String	getElementText()
java.lang.Object	getProperty(java.lang.String name) No properties are supported, so this always throws IllegalArgumentException.
boolean	hasNext()
java.lang.Object	next()
javax.xml.stream.events.XMLEvent	nextEvent()
javax.xml.stream.events.XMLEvent	nextTag()
javax.xml.stream.events.XMLEvent	peek()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStreamEventReader

public XMLStreamEventReader(javax.xml.stream.XMLStreamReader reader)

XMLStreamEventReader

public XMLStreamEventReader(javax.xml.stream.XMLStreamReader reader,
                    javax.xml.stream.util.XMLEventAllocator allocator)

Method Detail

getProperty

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

No properties are supported, so this always throws IllegalArgumentException.

Specified by:

getProperty in interface javax.xml.stream.XMLEventReader

Throws:

java.lang.IllegalArgumentException

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

Specified by:

hasNext in interface javax.xml.stream.XMLEventReader

nextTag

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

Specified by:

nextTag in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

getElementText

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

Specified by:

getElementText in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

nextEvent

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

Specified by:

nextEvent in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

peek

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

Specified by:

peek in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

next

public java.lang.Object next()

Specified by:

next in interface java.util.Iterator

remove

public void remove()

Specified by:

remove in interface java.util.Iterator

close

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

Specified by:

close in interface javax.xml.stream.XMLEventReader

Throws:

javax.xml.stream.XMLStreamException

allocateEvent

protected javax.xml.stream.events.XMLEvent allocateEvent()
                                                  throws javax.xml.stream.XMLStreamException

Reads the next event from the underlying reader.

Returns:

The allocated XMLEvent.

Throws:

javax.xml.stream.XMLStreamException - If an error occurs reading the underlying stream.