org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM2.ChildrenIterator

Enclosing Class:
SAX2DTM2
Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class SAX2DTM2.ChildrenIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns all immediate children of a given node

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Method Summary

int
next()
Get the next node in the iteration.
DTMAxisIterator
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

Method Details

next

public int next()
Get the next node in the iteration.
Specified by:
next in interface DTMAxisIterator
Returns:
The next node handle in the iteration, or END if no more are available.

setStartNode

public DTMAxisIterator setStartNode(int node)
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?

Specified by:
setStartNode in interface DTMAxisIterator
Parameters:
node - Sets the root of the iteration.
Returns:
A DTMAxisIterator set to the start of the iteration.

Copyright B) 2006 Apache XML Project. All Rights Reserved.