org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.ChildrenIterator

public final class DTMDefaultBaseIterators.ChildrenIterator extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns all immediate children of a given node
Method Summary
intnext()
Get the next node in the iteration.
DTMAxisIteratorsetStartNode(int node)
Setting start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Method Detail

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.

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?

Parameters: node Sets the root of the iteration.

Returns: A DTMAxisIterator set to the start of the iteration.

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