net.sf.saxon.tree.iter

Class PrependAxisIterator

java.lang.Object

net.sf.saxon.tree.iter.PrependSequenceIterator

net.sf.saxon.tree.iter.PrependAxisIterator

All Implemented Interfaces:

SequenceIterator, AxisIterator, UnfailingIterator

public class PrependAxisIterator
extends PrependSequenceIterator
implements AxisIterator

An iterator over nodes, that prepends a given node to the nodes returned by another iterator. Used to modify an iterator over axis A to one that iterates over A-OR-SELF.

Field Summary

Fields inherited from interface net.sf.saxon.om.SequenceIterator

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
PrependAxisIterator(NodeInfo start, AxisIterator base)

Method Summary

Modifier and Type	Method and Description
int	getProperties() Get properties of this iterator, as a bit-significant integer.
NodeInfo	next() Get the next item in the sequence.

Methods inherited from class net.sf.saxon.tree.iter.PrependSequenceIterator

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.SequenceIterator

close

Constructor Detail

PrependAxisIterator

public PrependAxisIterator(NodeInfo start,
                           AxisIterator base)

Method Detail

next

public NodeInfo next()

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator

Specified by:

next in interface AxisIterator

Specified by:

next in interface UnfailingIterator

Overrides:

next in class PrependSequenceIterator

Returns:

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

getProperties

public int getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Overrides:

getProperties in class PrependSequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.