Class DomReader

java.lang.Object

com.thoughtworks.xstream.io.AbstractReader

com.thoughtworks.xstream.io.xml.AbstractXmlReader

com.thoughtworks.xstream.io.xml.AbstractDocumentReader

com.thoughtworks.xstream.io.xml.DomReader

All Implemented Interfaces:

ErrorReporter, ExtendedHierarchicalStreamReader, HierarchicalStreamReader, DocumentReader

public class DomReader
extends AbstractDocumentReader

Field Summary

Fields

Modifier and Type	Field	Description
private List	childElements
private final FastStack	childrenStack
private Element	currentElement
private StringBuffer	textBuffer

Constructor Summary

Constructors

Constructor	Description
DomReader(Document document)
DomReader(Document document, NameCoder nameCoder)
DomReader(Document document, XmlFriendlyReplacer replacer)	Deprecated. As of 1.4, use DomReader(Document, NameCoder) instead.
DomReader(Element rootElement)
DomReader(Element rootElement, NameCoder nameCoder)
DomReader(Element rootElement, XmlFriendlyReplacer replacer)	Deprecated. As of 1.4, use DomReader(Element, NameCoder) instead.

Method Summary

Modifier and Type	Method	Description
private void	collectChildElements()
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 Object	getChild(int index)
protected int	getChildCount()
String	getNodeName()	Get the name of the current node.
protected Object	getParent()
String	getValue()	Get the value (text content) of the current node.
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.
protected void	reassignCurrentElement(Object current)

Methods inherited from class AbstractDocumentReader

appendErrors, close, getAttributeNames, getCurrent, hasMoreChildren

Methods inherited from class AbstractXmlReader

escapeXmlName, unescapeXmlName

Methods inherited from class AbstractReader

decodeAttribute, decodeNode, encodeAttribute, encodeNode, underlyingReader

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HierarchicalStreamReader

underlyingReader

Field Details

currentElement

private Element currentElement

textBuffer

private StringBuffer textBuffer

childElements

private List childElements

childrenStack

private final FastStack childrenStack

Constructor Details

DomReader

public DomReader(Element rootElement)

DomReader

public DomReader(Document document)

DomReader

public DomReader(Element rootElement,
 NameCoder nameCoder)

Since:

1.4

DomReader

public DomReader(Document document,
 NameCoder nameCoder)

Since:

1.4

DomReader

public DomReader(Element rootElement,
 XmlFriendlyReplacer replacer)

Deprecated.

As of 1.4, use DomReader(Element, NameCoder) instead.

Since:

1.2

DomReader

public DomReader(Document document,
 XmlFriendlyReplacer replacer)

Deprecated.

As of 1.4, use DomReader(Document, NameCoder) instead.

Since:

1.2

Method Details

getNodeName

public String getNodeName()

Description copied from interface: HierarchicalStreamReader

Get the name of the current node.

getValue

public String getValue()

Description copied from interface: HierarchicalStreamReader

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

getAttribute

public String getAttribute(String name)

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

public String getAttribute(int index)

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

public String getAttributeName(int index)

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.

getParent

protected Object getParent()

Specified by:

getParent in class AbstractDocumentReader

getChild

protected Object getChild(int index)

Specified by:

getChild in class AbstractDocumentReader

getChildCount

protected int getChildCount()

Specified by:

getChildCount in class AbstractDocumentReader

reassignCurrentElement

protected void reassignCurrentElement(Object current)

Specified by:

reassignCurrentElement in class AbstractDocumentReader

collectChildElements

private void collectChildElements()

moveDown

public void moveDown()

Description copied from interface: HierarchicalStreamReader

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

Specified by:

moveDown in interface HierarchicalStreamReader

Overrides:

moveDown in class AbstractDocumentReader

moveUp

public void moveUp()

Description copied from interface: HierarchicalStreamReader

Select the parent node as current node.

Specified by:

moveUp in interface HierarchicalStreamReader

Overrides:

moveUp in class AbstractDocumentReader

peekNextChild

public String peekNextChild()

Description copied from interface: ExtendedHierarchicalStreamReader

Peek the name of the next child. In situation where HierarchicalStreamReader.hasMoreChildren() returns true, peek the tag name of the child.

Specified by:

peekNextChild in interface ExtendedHierarchicalStreamReader

Overrides:

peekNextChild in class AbstractReader