Package org.apache.xml.dtm.ref
Class DTMDefaultBaseIterators.ChildrenIterator
java.lang.Object
org.apache.xml.dtm.ref.DTMAxisIteratorBase
org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
org.apache.xml.dtm.ref.DTMDefaultBaseIterators.ChildrenIterator
- All Implemented Interfaces:
Cloneable
,DTMAxisIterator
- Enclosing class:
- DTMDefaultBaseIterators
public final class DTMDefaultBaseIterators.ChildrenIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase
Iterator that returns all immediate children of a given node
-
Field Summary
Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator
END
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
next()
Get the next node in the iteration.setStartNode
(int node) Setting start to END should 'close' the iterator, i.e. subsequent call to next() should return END.Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
gotoMark, setMark
Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase
cloneIterator, getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, setRestartable
-
Constructor Details
-
ChildrenIterator
public ChildrenIterator()
-
-
Method Details
-
setStartNode
Setting start to END should 'close' the iterator, i.e. subsequent call to next() should return END. If the iterator is not restartable, this has no effect. %REVIEW% Should it return/throw something in that case, or set current node to END, to indicate request-not-honored?- Parameters:
node
- Sets the root of the iteration.- Returns:
- A DTMAxisIterator set to the start of the iteration.
-
next
public int next()Get the next node in the iteration.- Returns:
- The next node handle in the iteration, or END if no more are available.
-