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
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDom4JReader
(org.dom4j.Branch branch) Dom4JReader
(org.dom4j.Document document) Dom4JReader
(org.dom4j.Document document, NameCoder nameCoder) Dom4JReader
(org.dom4j.Document document, XmlFriendlyReplacer replacer) Deprecated.Dom4JReader
(org.dom4j.Element rootElement) Dom4JReader
(org.dom4j.Element rootElement, NameCoder nameCoder) Dom4JReader
(org.dom4j.Element rootElement, XmlFriendlyReplacer replacer) Deprecated.As of 1.4, useDom4JReader(Element, NameCoder)
instead -
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).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 Object
getChild
(int index) protected int
Get the name of the current node.protected Object
getValue()
Get the value (text content) of the current node.Peek the name of the next child.protected void
reassignCurrentElement
(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 Details
-
currentElement
private org.dom4j.Element currentElement
-
-
Constructor Details
-
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
- Since:
- 1.4
-
Dom4JReader
- Since:
- 1.4
-
Dom4JReader
Deprecated.As of 1.4, useDom4JReader(Element, NameCoder)
instead- Since:
- 1.2
-
Dom4JReader
Deprecated.As of 1.4, useDom4JReader(Document, NameCoder)
instead- Since:
- 1.2
-
-
Method Details
-
getNodeName
Description copied from interface:HierarchicalStreamReader
Get the name of the current node. -
getValue
Description copied from interface:HierarchicalStreamReader
Get the value (text content) of the current node. -
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.
-
getParent
- Specified by:
getParent
in classAbstractDocumentReader
-
getChild
- Specified by:
getChild
in classAbstractDocumentReader
-
getChildCount
protected int getChildCount()- Specified by:
getChildCount
in classAbstractDocumentReader
-
reassignCurrentElement
- Specified by:
reassignCurrentElement
in classAbstractDocumentReader
-
peekNextChild
Description copied from interface:ExtendedHierarchicalStreamReader
Peek the name of the next child. In situation whereHierarchicalStreamReader.hasMoreChildren()
returns true, peek the tag name of the child.- Specified by:
peekNextChild
in interfaceExtendedHierarchicalStreamReader
- Overrides:
peekNextChild
in classAbstractReader
-
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).- Specified by:
appendErrors
in interfaceErrorReporter
- Specified by:
appendErrors
in interfaceHierarchicalStreamReader
- Overrides:
appendErrors
in classAbstractDocumentReader
- Parameters:
errorWriter
- the error writer
-
Dom4JReader(Document, NameCoder)
instead