com.thoughtworks.xstream.io.xml
Class StaxReader

java.lang.Object
  extended by com.thoughtworks.xstream.io.AbstractReader
      extended by com.thoughtworks.xstream.io.xml.AbstractXmlReader
          extended by com.thoughtworks.xstream.io.xml.AbstractPullReader
              extended by com.thoughtworks.xstream.io.xml.StaxReader
All Implemented Interfaces:
ErrorReporter, ExtendedHierarchicalStreamReader, HierarchicalStreamReader

public class StaxReader
extends AbstractPullReader

A reader using the StAX API.

Version:
$Revision: 1861 $
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, XMLStreamReader in)
           
StaxReader(QNameMap qnameMap, XMLStreamReader in, NameCoder replacer)
           
StaxReader(QNameMap qnameMap, XMLStreamReader in, XmlFriendlyReplacer replacer)
          Deprecated. As of 1.4 use StaxReader(QNameMap, XMLStreamReader, NameCoder) instead.
 
Method Summary
 void appendErrors(ErrorWriter errorWriter)
          Append context information to an ErrorWriter.
 void close()
          Close the reader, if necessary.
 String getAttribute(int index)
          Get the value of an attribute of the current node, by index.
 String getAttribute(String name)
          Get the value of an attribute of the current node.
 int getAttributeCount()
          Number of attributes in current node.
 String getAttributeName(int index)
          Name of attribute in current node.
protected  String pullElementName()
          Pull the name of the current element from the stream.
protected  int pullNextEvent()
          Pull the next event from the stream.
protected  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, peekNextChild, reset
 
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractXmlReader
escapeXmlName, unescapeXmlName
 
Methods inherited from class com.thoughtworks.xstream.io.AbstractReader
decodeAttribute, decodeNode, encodeAttribute, encodeNode, underlyingReader
 
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,
                  XMLStreamReader in)

StaxReader

public StaxReader(QNameMap qnameMap,
                  XMLStreamReader in,
                  NameCoder replacer)
Since:
1.4

StaxReader

public StaxReader(QNameMap qnameMap,
                  XMLStreamReader in,
                  XmlFriendlyReplacer replacer)
Deprecated. As of 1.4 use StaxReader(QNameMap, XMLStreamReader, NameCoder) instead.

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 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 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 String getAttribute(String name)
Description copied from interface: HierarchicalStreamReader
Get the value of an attribute of the current node.


getAttribute

public 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 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: ErrorReporter
Append context information to an ErrorWriter.

Parameters:
errorWriter - the error writer

close

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



Copyright © 2004-2014 XStream. All Rights Reserved.