Class JDom2Reader

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

All Implemented Interfaces:

ErrorReporter, ExtendedHierarchicalStreamReader, HierarchicalStreamReader, DocumentReader

public class JDom2Reader
extends AbstractDocumentReader

Since:

1.4.5

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
JDom2Reader(org.jdom2.Document document)
JDom2Reader(org.jdom2.Document document, NameCoder nameCoder)
JDom2Reader(org.jdom2.Element root)
JDom2Reader(org.jdom2.Element root, NameCoder nameCoder)

Method Summary

Modifier and Type	Method	Description
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.
String	peekNextChild()	Peek the name of the next child.
protected void	reassignCurrentElement(Object current)

Methods inherited from class AbstractDocumentReader

appendErrors, close, getAttributeNames, getCurrent, hasMoreChildren, moveDown, moveUp

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 org.jdom2.Element currentElement

Constructor Details

JDom2Reader

public JDom2Reader(org.jdom2.Element root)

Since:

1.4.5

JDom2Reader

public JDom2Reader(org.jdom2.Document document)

Since:

1.4.5

JDom2Reader

public JDom2Reader(org.jdom2.Element root,
 NameCoder nameCoder)

Since:

1.4.5

JDom2Reader

public JDom2Reader(org.jdom2.Document document,
 NameCoder nameCoder)

Since:

1.4.5

Method Details

reassignCurrentElement

protected void reassignCurrentElement(Object current)

Specified by:

reassignCurrentElement in class AbstractDocumentReader

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

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.

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