|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.io.xml.AbstractXmlReader
edu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.io.xml.AbstractDocumentReader
public abstract class AbstractDocumentReader
| Constructor Summary | |
|---|---|
protected |
AbstractDocumentReader(Object rootElement)
|
protected |
AbstractDocumentReader(Object rootElement,
XmlFriendlyReplacer replacer)
|
| Method Summary | |
|---|---|
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). |
void |
close()
Close the reader, if necessary. |
Iterator |
getAttributeNames()
Names of attributes (as Strings). |
protected abstract Object |
getChild(int index)
|
protected abstract int |
getChildCount()
|
Object |
getCurrent()
Retrieve the current processed node of the DOM. |
protected abstract Object |
getParent()
|
boolean |
hasMoreChildren()
Does the node have any more children remaining that have not yet been read? |
void |
moveDown()
Select the current child as current node. |
void |
moveUp()
Select the parent node as current node. |
Object |
peekUnderlyingNode()
Deprecated. As of 1.2, use getCurrent() |
protected abstract void |
reassignCurrentElement(Object current)
|
HierarchicalStreamReader |
underlyingReader()
Return the underlying HierarchicalStreamReader implementation. |
| Methods inherited from class edu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.io.xml.AbstractXmlReader |
|---|
unescapeXmlName |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface edu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.io.HierarchicalStreamReader |
|---|
getAttribute, getAttribute, getAttributeCount, getAttributeName, getNodeName, getValue |
| Constructor Detail |
|---|
protected AbstractDocumentReader(Object rootElement)
protected AbstractDocumentReader(Object rootElement,
XmlFriendlyReplacer replacer)
| Method Detail |
|---|
protected abstract void reassignCurrentElement(Object current)
protected abstract Object getParent()
protected abstract Object getChild(int index)
protected abstract int getChildCount()
public boolean hasMoreChildren()
HierarchicalStreamReader
hasMoreChildren in interface HierarchicalStreamReaderpublic void moveUp()
HierarchicalStreamReader
moveUp in interface HierarchicalStreamReaderpublic void moveDown()
HierarchicalStreamReaderHierarchicalStreamReader.moveUp().
moveDown in interface HierarchicalStreamReaderpublic Iterator getAttributeNames()
HierarchicalStreamReader
getAttributeNames in interface HierarchicalStreamReaderpublic void appendErrors(ErrorWriter errorWriter)
HierarchicalStreamReader
appendErrors in interface HierarchicalStreamReaderpublic Object peekUnderlyingNode()
getCurrent()
public Object getCurrent()
DocumentReader
getCurrent in interface DocumentReaderpublic void close()
HierarchicalStreamReader
close in interface HierarchicalStreamReaderpublic HierarchicalStreamReader underlyingReader()
HierarchicalStreamReaderIf a Converter needs to access methods of a specific HierarchicalStreamReader implementation that are not defined in the HierarchicalStreamReader interface, it should call this method before casting. This is because the reader passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).
For example:
MySpecificReader mySpecificReader = (MySpecificReader)reader; // INCORRECT! mySpecificReader.doSomethingSpecific();
MySpecificReader mySpecificReader = (MySpecificReader)reader.underlyingReader(); // CORRECT! mySpecificReader.doSomethingSpecific();
Implementations of HierarchicalStreamReader should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.
underlyingReader in interface HierarchicalStreamReader
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||