net.sf.saxon.om
Class SingletonIterator

java.lang.Object
  net.sf.saxon.om.SingletonIterator

All Implemented Interfaces:

LastPositionFinder, ReversibleIterator, AxisIterator, SequenceIterator

public class SingletonIterator
extends Object
implements AxisIterator, ReversibleIterator, LastPositionFinder

SingletonIterator: an iterator over a sequence of zero or one values

Method Summary

Item	current() Get the current item in the sequence.
SequenceIterator	getAnother() Get another iterator over the same sequence of items, positioned at the start of the sequence
int	getLastPosition() Get the last position (that is, the number of items in the sequence)
SequenceIterator	getReverseIterator() Indicate that any nodes returned in the sequence will be atomized.
Item	getValue()
static AxisIterator	makeIterator(Item item) Factory method.
Item	next() Get the next item in the sequence.
int	position() Get the current position

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

makeIterator

public static AxisIterator makeIterator(Item item)

Factory method.

Parameters:

item - the item to iterate over

Returns:

a SingletonIterator over the supplied item, or an EmptyIterator if the supplied item is null.

next

public Item next()

Description copied from interface: AxisIterator

Get the next item in the sequence.

Specified by:

next in interface AxisIterator

Specified by:

next in interface SequenceIterator

Returns:

the next Item. If there are no more nodes, return null.

current

public Item current()

Description copied from interface: AxisIterator

Get the current item in the sequence.

Specified by:

current in interface AxisIterator

Specified by:

current in interface SequenceIterator

Returns:

the current item, that is, the item most recently returned by next()

position

public int position()

Description copied from interface: AxisIterator

Get the current position

Specified by:

position in interface AxisIterator

Specified by:

position in interface SequenceIterator

Returns:

the position of the current item (the item most recently returned by next()), starting at 1 for the first node

getLastPosition

public int getLastPosition()

Description copied from interface: LastPositionFinder

Get the last position (that is, the number of items in the sequence)

Specified by:

getLastPosition in interface LastPositionFinder

getAnother

public SequenceIterator getAnother()

Description copied from interface: AxisIterator

Get another iterator over the same sequence of items, positioned at the start of the sequence

Specified by:

getAnother in interface AxisIterator

Specified by:

getAnother in interface SequenceIterator

Returns:

a new iterator over the same sequence

getReverseIterator

public SequenceIterator getReverseIterator()

Indicate that any nodes returned in the sequence will be atomized. This means that if it wishes to do so, the implementation can return the typed values of the nodes rather than the nodes themselves. The implementation is free to ignore this hint.

Specified by:

getReverseIterator in interface ReversibleIterator

Parameters:

atomizing - true if the caller of this iterator will atomize any nodes that are returned, and is therefore willing to accept the typed value of the nodes instead of the nodes themselves.

getValue

public Item getValue()