com.ctc.wstx.evt
Class WstxEventReader

java.lang.Object
  extended by org.codehaus.stax2.ri.Stax2EventReaderImpl
      extended by com.ctc.wstx.evt.WstxEventReader
All Implemented Interfaces:
Iterator, XMLEventReader, XMLStreamConstants, XMLEventReader2

public class WstxEventReader
extends Stax2EventReaderImpl

Woodstox version, based on generic Stax reference implementation baseline of Stax2EventReaderImpl.


Field Summary
 
Fields inherited from class org.codehaus.stax2.ri.Stax2EventReaderImpl
ERR_GETELEMTEXT_NON_TEXT_EVENT, ERR_GETELEMTEXT_NOT_START_ELEM, ERR_NEXTTAG_NON_WS_TEXT, ERR_NEXTTAG_WRONG_TYPE, mAllocator, mPrePeekEvent, mReader, mState, STATE_CONTENT, STATE_END_OF_INPUT, 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(XMLEventAllocator a, XMLStreamReader2 r)
           
 
Method Summary
protected  String getErrorDesc(int errorType, int currEvent)
          Method called upon encountering a problem that should result in an exception being thrown.
 boolean isPropertySupported(String name)
          Method similar to XMLInputFactory.isPropertySupported(java.lang.String), used to determine whether a property is supported by the Reader instance.
protected  void reportProblem(String msg, Location loc)
           
 boolean setProperty(String name, Object value)
          Method that can be used to set per-reader properties; a subset of properties one can set via matching XMLInputFactory2 instance.
 
Methods inherited from class org.codehaus.stax2.ri.Stax2EventReaderImpl
close, createNextEvent, createStartDocumentEvent, getElementText, getProperty, getStreamReader, hasNext, hasNextEvent, next, nextEvent, nextTag, peek, remove, reportProblem, throwUnchecked
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WstxEventReader

public WstxEventReader(XMLEventAllocator a,
                       XMLStreamReader2 r)
Method Detail

getErrorDesc

protected String getErrorDesc(int errorType,
                              int currEvent)
Description copied from class: Stax2EventReaderImpl
Method called upon encountering a problem that should result in an exception being thrown. If non-null String is returned. that will be used as the message of exception thrown; if null, a standard message will be used instead.

Specified by:
getErrorDesc in class Stax2EventReaderImpl
Parameters:
errorType - Type of the problem, one of ERR_ constants
currEvent - Type of the event that triggered the problem, if any; -1 if not available.

isPropertySupported

public boolean isPropertySupported(String name)
Description copied from interface: XMLEventReader2
Method similar to XMLInputFactory.isPropertySupported(java.lang.String), used to determine whether a property is supported by the Reader instance. This means that this method may return false for some properties that the input factory does support: specifically, it should only return true if the value is mutable on per-instance basis. False means that either the property is not recognized, or is not mutable via reader instance.

Specified by:
isPropertySupported in interface XMLEventReader2
Specified by:
isPropertySupported in class Stax2EventReaderImpl

setProperty

public boolean setProperty(String name,
                           Object value)
Description copied from interface: XMLEventReader2
Method that can be used to set per-reader properties; a subset of properties one can set via matching XMLInputFactory2 instance. Exactly which methods are mutable is implementation specific.

Specified by:
setProperty in interface XMLEventReader2
Specified by:
setProperty in class Stax2EventReaderImpl
Parameters:
name - Name of the property to set
value - Value to set property to.
Returns:
True, if the specified property was succesfully set to specified value; false if its value was not changed

reportProblem

protected void reportProblem(String msg,
                             Location loc)
                      throws XMLStreamException
Overrides:
reportProblem in class Stax2EventReaderImpl
Throws:
XMLStreamException