Package com.thoughtworks.xstream.io.xml
Class StaxReader
java.lang.Object
com.thoughtworks.xstream.io.AbstractReader
com.thoughtworks.xstream.io.xml.AbstractXmlReader
com.thoughtworks.xstream.io.xml.AbstractPullReader
com.thoughtworks.xstream.io.xml.StaxReader
- All Implemented Interfaces:
ErrorReporter
,ExtendedHierarchicalStreamReader
,HierarchicalStreamReader
A reader using the StAX API.
- Version:
- $Revision$
-
Field Summary
FieldsFields inherited from class com.thoughtworks.xstream.io.xml.AbstractPullReader
COMMENT, END_NODE, OTHER, START_NODE, TEXT
-
Constructor Summary
ConstructorsConstructorDescriptionStaxReader
(QNameMap qnameMap, XMLStreamReader in) StaxReader
(QNameMap qnameMap, XMLStreamReader in, NameCoder replacer) StaxReader
(QNameMap qnameMap, XMLStreamReader in, XmlFriendlyReplacer replacer) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.getAttribute
(int index) Get the value of an attribute of the current node, by index.getAttribute
(String name) Get the value of an attribute of the current node.int
Number of attributes in current node.getAttributeName
(int index) Name of attribute in current node.protected String
Pull the name of the current element from the stream.protected int
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
-
Field Details
-
qnameMap
-
in
-
-
Constructor Details
-
StaxReader
-
StaxReader
- Since:
- 1.4
-
StaxReader
Deprecated.As of 1.4 useStaxReader(QNameMap, XMLStreamReader, NameCoder)
instead.- Since:
- 1.2
-
-
Method Details
-
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 throwStreamException
.The underlying pull parser will most likely return its own event types. These must be mapped to the appropriate events.
- Specified by:
pullNextEvent
in classAbstractPullReader
-
pullElementName
Description copied from class:AbstractPullReader
Pull the name of the current element from the stream.- Specified by:
pullElementName
in classAbstractPullReader
-
pullText
Description copied from class:AbstractPullReader
Pull the contents of the current text node from the stream.- Specified by:
pullText
in classAbstractPullReader
-
getAttribute
Description copied from interface:HierarchicalStreamReader
Get the value of an attribute of the current node.If no such attribute exists, the method returns null.
-
getAttribute
Description copied from interface:HierarchicalStreamReader
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
public int getAttributeCount()Description copied from interface:HierarchicalStreamReader
Number of attributes in current node. -
getAttributeName
Description copied from interface:HierarchicalStreamReader
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.
-
appendErrors
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).- Parameters:
errorWriter
- the error writer
-
close
public void close()Description copied from interface:HierarchicalStreamReader
Close the reader, if necessary.
-
StaxReader(QNameMap, XMLStreamReader, NameCoder)
instead.