org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.SingletonIterator

public class DTMDefaultBaseIterators.SingletonIterator extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Class SingletonIterator.
Constructor Summary
SingletonIterator()
Constructor SingletonIterator
SingletonIterator(int node)
Constructor SingletonIterator
SingletonIterator(int node, boolean constant)
Constructor SingletonIterator
Method Summary
intnext()
Get the next node in the iteration.
DTMAxisIteratorreset()
Resets the iterator to the last start node.
DTMAxisIteratorsetStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Constructor Detail

SingletonIterator

public SingletonIterator()
Constructor SingletonIterator

SingletonIterator

public SingletonIterator(int node)
Constructor SingletonIterator

Parameters: node The node handle to return.

SingletonIterator

public SingletonIterator(int node, boolean constant)
Constructor SingletonIterator

Parameters: node the node handle to return. constant (Not sure what this is yet. -sb)

Method Detail

next

public int next()
Get the next node in the iteration.

Returns: The next node handle in the iteration, or END.

reset

public DTMAxisIterator reset()
Resets the iterator to the last start node.

Returns: A DTMAxisIterator, which may or may not be the same as this iterator.

setStartNode

public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

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.