WstxEventReader (Woodstox XML processor)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ctc.wstx.evt
Class WstxEventReader

java.lang.Object
  com.ctc.wstx.evt.WstxEventReader

All Implemented Interfaces:: java.util.Iterator, javax.xml.stream.XMLEventReader, javax.xml.stream.XMLStreamConstants, XMLEventReader2

public class WstxEventReader
extends java.lang.Object
implements XMLEventReader2, javax.xml.stream.XMLStreamConstants
extends java.lang.Object
implements XMLEventReader2, javax.xml.stream.XMLStreamConstants

Implementation of XMLEventReader, built on top of BasicStreamReader (using composition). Since there is not much to optimize at this level (API and underlying stream reader pretty much define functionality and optimizations that can be done), implementation is fairly straight forward, with not many surprises.

Implementation notes: trickiest things to implement are:

Peek() functionality! Geez, why did that have to be part of StAX specs???!
Adding START_DOCUMENT event that cursor API does not return explicitly.

Field Summary
`protected int`	`mPrePeekEvent` This variable keeps track of the type of the 'previous' event when peeking for the next Event.
`protected int`	`mState` High-level state indicator, with currently three values: whether we are initializing (need to synthetize START_DOCUMENT), at EOD (end-of-doc), or otherwise, normal operation.
`protected static int`	`STATE_CONTENT`
`protected static int`	`STATE_EOD`
`protected static int`	`STATE_INITIAL`

Fields inherited from interface javax.xml.stream.XMLStreamConstants
`ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT`

Constructor Summary
`WstxEventReader(javax.xml.stream.util.XMLEventAllocator a, javax.xml.stream.XMLStreamReader r)`

Method Summary
`void`	`close()`
`protected javax.xml.stream.events.XMLEvent`	`createNextEvent(boolean checkEOD, int type)`
`protected javax.xml.stream.events.XMLEvent`	`createStartEvent()` Method called to create the very first START_DOCUMENT event.
`java.lang.String`	`getElementText()`
`java.lang.Object`	`getProperty(java.lang.String name)`
`boolean`	`hasNext()`
`boolean`	`hasNextEvent()` Note: although the interface allows implementations to throw an `XMLStreamException`, Woodstox doesn't currently need to.
`java.lang.Object`	`next()`
`javax.xml.stream.events.XMLEvent`	`nextEvent()`
`javax.xml.stream.events.XMLEvent`	`nextTag()`
`javax.xml.stream.events.XMLEvent`	`peek()`
`void`	`remove()` Note: only here because we implement Iterator interface
`protected void`	`throwFromSex(javax.xml.stream.XMLStreamException sex)`
`protected void`	`throwParseError(java.lang.String msg)`
`protected void`	`throwParseError(java.lang.String msg, javax.xml.stream.Location loc)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

STATE_INITIAL

protected static final int STATE_INITIAL

See Also:: Constant Field Values

STATE_EOD

protected static final int STATE_EOD

See Also:: Constant Field Values

STATE_CONTENT

protected static final int STATE_CONTENT

See Also:: Constant Field Values

mState

protected int mState

High-level state indicator, with currently three values: whether we are initializing (need to synthetize START_DOCUMENT), at EOD (end-of-doc), or otherwise, normal operation. Useful in simplifying some methods, as well as to make sure that independent of how stream reader handles things, event reader can reliably detect End-Of-Document.

mPrePeekEvent

protected int mPrePeekEvent

This variable keeps track of the type of the 'previous' event when peeking for the next Event. It is needed for some functionality, to remember state even when underlying parser has to move to peek the next event.

Constructor Detail