com.thoughtworks.xstream.io

Interface HierarchicalStreamReader

All Superinterfaces:

ErrorReporter

All Known Subinterfaces:

DocumentReader, ExtendedHierarchicalStreamReader

All Known Implementing Classes:

AbstractDocumentReader, AbstractPullReader, AbstractReader, AbstractXmlReader, BinaryStreamReader, Dom4JReader, DomReader, JDom2Reader, JDomReader, PathTrackingReader, ReaderWrapper, StaxReader, XomReader, XppDomReader, XppReader

public interface HierarchicalStreamReader
extends ErrorReporter

Author:

Joe Walnes

Method Summary

Modifier and Type	Method and Description
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.
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.
Iterator	getAttributeNames() Iterator with the names of the attributes.
String	getNodeName() Get the name of the current node.
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

boolean hasMoreChildren()

Does the node have any more children remaining that have not yet been read?

moveDown

void moveDown()

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

moveUp

void moveUp()

Select the parent node as current node.

getNodeName

String getNodeName()

Get the name of the current node.

getValue

String getValue()

Get the value (text content) of the current node.

getAttribute

String getAttribute(String name)

Get the value of an attribute of the current node.

If no such attribute exists, the method returns null.

getAttribute

String getAttribute(int index)

Get the value of an attribute of the current node, by index.

Note, the behavior of this method is dependent on the underlying parser when calling it with a non-existing index. Typically some kind of RuntimeException is thrown.

getAttributeCount

int getAttributeCount()

Number of attributes in current node.

getAttributeName

String getAttributeName(int index)

Name of attribute in current node.

Note, the behavior of this method is dependent on the underlying parser when calling it with a non-existing index. Typically some kind of RuntimeException is thrown.

getAttributeNames

Iterator getAttributeNames()

Iterator with the names of the attributes.

Note, the iterator is only valid as long as the internal state of the underlying parser is still at the start of the current element. The behavior is undefined if the parser moved on.

appendErrors

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

Specified by:

appendErrors in interface ErrorReporter

Parameters:

errorWriter - the error writer

close

void close()

Close the reader, if necessary.

underlyingReader

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.