public class BinaryStreamReader extends Object implements ExtendedHierarchicalStreamReader
BinaryStreamWriter.BinaryStreamReader| Constructor and Description |
|---|
BinaryStreamReader(InputStream inputStream) |
| 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.
|
String |
peekNextChild()
Peek the name of the next child.
|
void |
pushBack(Token token) |
HierarchicalStreamReader |
underlyingReader()
Return the underlying HierarchicalStreamReader implementation.
|
public BinaryStreamReader(InputStream inputStream)
public boolean hasMoreChildren()
HierarchicalStreamReaderhasMoreChildren in interface HierarchicalStreamReaderpublic String getNodeName()
HierarchicalStreamReadergetNodeName in interface HierarchicalStreamReaderpublic String getValue()
HierarchicalStreamReadergetValue in interface HierarchicalStreamReaderpublic String getAttribute(String name)
HierarchicalStreamReaderIf no such attribute exists, the method returns null.
getAttribute in interface HierarchicalStreamReaderpublic String getAttribute(int index)
HierarchicalStreamReaderNote, 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.
getAttribute in interface HierarchicalStreamReaderpublic int getAttributeCount()
HierarchicalStreamReadergetAttributeCount in interface HierarchicalStreamReaderpublic String getAttributeName(int index)
HierarchicalStreamReaderNote, 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.
getAttributeName in interface HierarchicalStreamReaderpublic Iterator getAttributeNames()
HierarchicalStreamReaderNote, 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.
getAttributeNames in interface HierarchicalStreamReaderpublic void moveDown()
HierarchicalStreamReaderHierarchicalStreamReader.moveUp().moveDown in interface HierarchicalStreamReaderpublic void moveUp()
HierarchicalStreamReadermoveUp in interface HierarchicalStreamReaderpublic void pushBack(Token token)
public void close()
HierarchicalStreamReaderclose in interface HierarchicalStreamReaderpublic String peekNextChild()
ExtendedHierarchicalStreamReaderHierarchicalStreamReader.hasMoreChildren() returns
true, peek the tag name of the child.peekNextChild in interface ExtendedHierarchicalStreamReaderpublic HierarchicalStreamReader underlyingReader()
HierarchicalStreamReaderIf 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.
underlyingReader in interface HierarchicalStreamReaderpublic void appendErrors(ErrorWriter errorWriter)
HierarchicalStreamReaderappendErrors in interface ErrorReporterappendErrors in interface HierarchicalStreamReadererrorWriter - the error writerCopyright © 2004–2017 XStream. All rights reserved.