com.thoughtworks.xstream.io.xml
Class StaxReader

java.lang.Object
  extended bycom.thoughtworks.xstream.io.xml.AbstractXmlReader
      extended bycom.thoughtworks.xstream.io.xml.AbstractPullReader
          extended bycom.thoughtworks.xstream.io.xml.StaxReader
All Implemented Interfaces:
HierarchicalStreamReader

public class StaxReader
extends AbstractPullReader

A reader using the StAX API.

Version:
$Revision: 1049 $
Author:
James Strachan

Field Summary
 
Fields inherited from class com.thoughtworks.xstream.io.xml.AbstractPullReader
COMMENT, END_NODE, OTHER, START_NODE, TEXT
 
Constructor Summary
StaxReader(QNameMap qnameMap, javax.xml.stream.XMLStreamReader in)
           
StaxReader(QNameMap qnameMap, javax.xml.stream.XMLStreamReader in, XmlFriendlyReplacer replacer)
           
 
Method Summary
 void appendErrors(ErrorWriter errorWriter)
          If any errors are detected, allow the reader to add any additional information that can aid debugging (such as line numbers, XPath expressions, etc).
 void close()
          Close the reader, if necessary.
 java.lang.String getAttribute(int index)
          Get the value of an attribute of the current node, by index.
 java.lang.String getAttribute(java.lang.String name)
          Get the value of an attribute of the current node.
 int getAttributeCount()
          Number of attributes in current node.
 java.lang.String getAttributeName(int index)
          Name of attribute in current node.
protected  java.lang.String pullElementName()
          Pull the name of the current element from the stream.
protected  int pullNextEvent()
          Pull the next event from the stream.
protected  java.lang.String pullText()
          Pull the contents of the current text node from the stream.
 
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractPullReader
getAttributeNames, getNodeName, getValue, hasMoreChildren, mark, moveDown, moveUp, reset, underlyingReader
 
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractXmlReader
unescapeXmlName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StaxReader

public StaxReader(QNameMap qnameMap,
                  javax.xml.stream.XMLStreamReader in)

StaxReader

public StaxReader(QNameMap qnameMap,
                  javax.xml.stream.XMLStreamReader in,
                  XmlFriendlyReplacer replacer)
Since:
1.2
Method Detail

pullNextEvent

protected int pullNextEvent()
Description copied from class: AbstractPullReader
Pull the next event from the stream.

This MUST return AbstractPullReader.START_NODE, AbstractPullReader.END_NODE, AbstractPullReader.TEXT, AbstractPullReader.COMMENT, AbstractPullReader.OTHER or throw StreamException.

The underlying pull parser will most likely return its own event types. These must be mapped to the appropriate events.

Specified by:
pullNextEvent in class AbstractPullReader

pullElementName

protected java.lang.String pullElementName()
Description copied from class: AbstractPullReader
Pull the name of the current element from the stream.

Specified by:
pullElementName in class AbstractPullReader

pullText

protected java.lang.String pullText()
Description copied from class: AbstractPullReader
Pull the contents of the current text node from the stream.

Specified by:
pullText in class AbstractPullReader

getAttribute

public java.lang.String getAttribute(java.lang.String name)
Description copied from interface: HierarchicalStreamReader
Get the value of an attribute of the current node.


getAttribute

public java.lang.String getAttribute(int index)
Description copied from interface: HierarchicalStreamReader
Get the value of an attribute of the current node, by index.


getAttributeCount

public int getAttributeCount()
Description copied from interface: HierarchicalStreamReader
Number of attributes in current node.


getAttributeName

public java.lang.String getAttributeName(int index)
Description copied from interface: HierarchicalStreamReader
Name of attribute in current node.


appendErrors

public void appendErrors(ErrorWriter errorWriter)
Description copied from interface: HierarchicalStreamReader
If any errors are detected, allow the reader to add any additional information that can aid debugging (such as line numbers, XPath expressions, etc).


close

public void close()
Description copied from interface: HierarchicalStreamReader
Close the reader, if necessary.



Joe Walnes, http://xstream.codehaus.org/