Package com.thoughtworks.xstream.io.xml

Class Dom4JReader

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

All Implemented Interfaces:

ErrorReporter, ExtendedHierarchicalStreamReader, HierarchicalStreamReader, DocumentReader

public class Dom4JReader
extends AbstractDocumentReader

Field Summary

Fields

Modifier and Type	Field	Description
private org.dom4j.Element	currentElement

Constructor Summary

Constructors

Constructor	Description
Dom4JReader(org.dom4j.Branch branch)
Dom4JReader(org.dom4j.Document document)
Dom4JReader(org.dom4j.Document document, NameCoder nameCoder)
Dom4JReader(org.dom4j.Document document, XmlFriendlyReplacer replacer)	Deprecated. As of 1.4, use Dom4JReader(Document, NameCoder) instead
Dom4JReader(org.dom4j.Element rootElement)
Dom4JReader(org.dom4j.Element rootElement, NameCoder nameCoder)
Dom4JReader(org.dom4j.Element rootElement, XmlFriendlyReplacer replacer)	Deprecated. As of 1.4, use Dom4JReader(Element, NameCoder) instead

Method Summary

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

Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractDocumentReader

close, getAttributeNames, getCurrent, hasMoreChildren, moveDown, moveUp

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thoughtworks.xstream.io.HierarchicalStreamReader

underlyingReader

Field Detail

currentElement

private org.dom4j.Element currentElement

Constructor Detail

Dom4JReader

public Dom4JReader(org.dom4j.Branch branch)

Since:

1.4.11

Dom4JReader

public Dom4JReader(org.dom4j.Element rootElement)

Dom4JReader

public Dom4JReader(org.dom4j.Document document)

Dom4JReader

public Dom4JReader(org.dom4j.Element rootElement,
                   NameCoder nameCoder)

Since:

1.4

Dom4JReader

public Dom4JReader(org.dom4j.Document document,
                   NameCoder nameCoder)

Since:

1.4

Dom4JReader

public Dom4JReader(org.dom4j.Element rootElement,
                   XmlFriendlyReplacer replacer)

Deprecated.

As of 1.4, use Dom4JReader(Element, NameCoder) instead

Since:

1.2

Dom4JReader

public Dom4JReader(org.dom4j.Document document,
                   XmlFriendlyReplacer replacer)

Deprecated.

As of 1.4, use Dom4JReader(Document, NameCoder) instead

Since:

1.2

Method Detail

getNodeName

public java.lang.String getNodeName()

Description copied from interface: HierarchicalStreamReader

Get the name of the current node.

getValue

public java.lang.String getValue()

Description copied from interface: HierarchicalStreamReader

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

getAttribute

public java.lang.String getAttribute(java.lang.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 java.lang.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 java.lang.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 java.lang.Object getParent()

Specified by:

getParent in class AbstractDocumentReader

getChild

protected java.lang.Object getChild(int index)

Specified by:

getChild in class AbstractDocumentReader

getChildCount

protected int getChildCount()

Specified by:

getChildCount in class AbstractDocumentReader

reassignCurrentElement

protected void reassignCurrentElement(java.lang.Object current)

Specified by:

reassignCurrentElement in class AbstractDocumentReader

peekNextChild

public java.lang.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

appendErrors

public void appendErrors(ErrorWriter errorWriter)

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

Specified by:

appendErrors in interface ErrorReporter

Specified by:

appendErrors in interface HierarchicalStreamReader

Overrides:

appendErrors in class AbstractDocumentReader

Parameters:

errorWriter - the error writer