org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.SingletonIterator

Enclosing Class:
DTMDefaultBaseIterators
Implemented Interfaces:
Cloneable, DTMAxisIterator
Known Direct Subclasses:
DTMDefaultBaseIterators.TypedSingletonIterator, SAX2DTM2.TypedSingletonIterator

public class DTMDefaultBaseIterators.SingletonIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Class SingletonIterator.

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

END

Constructor Summary

SingletonIterator()
Constructor SingletonIterator
SingletonIterator(int node)
Constructor SingletonIterator
SingletonIterator(int node, boolean constant)
Constructor SingletonIterator

Method Summary

int
next()
Get the next node in the iteration.
DTMAxisIterator
reset()
Resets the iterator to the last start node.
DTMAxisIterator
setStartNode(int node)
Set 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

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 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.

reset

public DTMAxisIterator reset()
Resets the iterator to the last start node.
Specified by:
reset in interface DTMAxisIterator
Overrides:
reset in interface DTMAxisIteratorBase
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.
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) 2005 Apache XML Project. All Rights Reserved.