com.thoughtworks.xstream.io
Interface HierarchicalStreamReader

All Known Subinterfaces:
DocumentReader
All Known Implementing Classes:
AbstractDocumentReader, AbstractXmlReader, BinaryStreamReader, ReaderWrapper

public interface HierarchicalStreamReader

Author:
Joe Walnes

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.
 java.util.Iterator getAttributeNames()
          Names of attributes (as Strings).
 java.lang.String getNodeName()
          Get the name of the current node.
 java.lang.String getValue()
          Get the value (text content) of the current node.
 boolean hasMoreChildren()
          Does the node have any more children remaining that have not yet been read?
 void moveDown()
          Select the current child as current node.
 void moveUp()
          Select the parent node as current node.
 HierarchicalStreamReader underlyingReader()
          Return the underlying HierarchicalStreamReader implementation.
 

Method Detail

hasMoreChildren

public boolean hasMoreChildren()
Does the node have any more children remaining that have not yet been read?


moveDown

public void moveDown()
Select the current child as current node. A call to this function must be balanced with a call to moveUp().


moveUp

public void moveUp()
Select the parent node as current node.


getNodeName

public java.lang.String getNodeName()
Get the name of the current node.


getValue

public java.lang.String getValue()
Get the value (text content) of the current node.


getAttribute

public java.lang.String getAttribute(java.lang.String name)
Get the value of an attribute of the current node.


getAttribute

public java.lang.String getAttribute(int index)
Get the value of an attribute of the current node, by index.


getAttributeCount

public int getAttributeCount()
Number of attributes in current node.


getAttributeName

public java.lang.String getAttributeName(int index)
Name of attribute in current node.


getAttributeNames

public java.util.Iterator getAttributeNames()
Names of attributes (as Strings).


appendErrors

public 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).


close

public void close()
Close the reader, if necessary.


underlyingReader

public HierarchicalStreamReader underlyingReader()
Return the underlying HierarchicalStreamReader implementation.

If a Converter needs to access methods of a specific HierarchicalStreamReader implementation that are not defined in the HierarchicalStreamReader interface, it should call this method before casting. This is because the reader passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).

For example:

MySpecificReader mySpecificReader = (MySpecificReader)reader; // INCORRECT!
 mySpecificReader.doSomethingSpecific();
MySpecificReader mySpecificReader = (MySpecificReader)reader.underlyingReader();  // CORRECT!
 mySpecificReader.doSomethingSpecific();

Implementations of HierarchicalStreamReader should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.



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