<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:21 GMT 2011 -->
<TITLE>
SequenceIterator
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SequenceIterator";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/SelectedElementsSpaceStrippingRule.StripRuleTarget.html" title="class in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/SpaceStrippingRule.html" title="interface in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/SequenceIterator.html" target="_top"><B>FRAMES</B></A>
<A HREF="SequenceIterator.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.om</FONT>
<BR>
Interface SequenceIterator<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A><T>, <A HREF="../../../../net/sf/saxon/tree/iter/GroundedIterator.html" title="interface in net.sf.saxon.tree.iter">GroundedIterator</A><T>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupIterator.html" title="interface in net.sf.saxon.expr.sort">GroupIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/LookaheadIterator.html" title="interface in net.sf.saxon.tree.iter">LookaheadIterator</A><T>, <A HREF="../../../../net/sf/saxon/functions/regex/RegexIterator.html" title="interface in net.sf.saxon.functions.regex">RegexIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/ReversibleIterator.html" title="interface in net.sf.saxon.tree.iter">ReversibleIterator</A><T>, <A HREF="../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><T></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/sf/saxon/tree/iter/AdjacentTextNodeMergingIterator.html" title="class in net.sf.saxon.tree.iter">AdjacentTextNodeMergingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/ArrayIterator.html" title="class in net.sf.saxon.tree.iter">ArrayIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/AtomizingIterator.html" title="class in net.sf.saxon.tree.iter">AtomizingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/AxisAtomizingIterator.html" title="class in net.sf.saxon.expr">AxisAtomizingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/AxisIteratorImpl.html" title="class in net.sf.saxon.tree.iter">AxisIteratorImpl</A>, <A HREF="../../../../net/sf/saxon/tree/iter/AxisIteratorOverSequence.html" title="class in net.sf.saxon.tree.iter">AxisIteratorOverSequence</A>, <A HREF="../../../../net/sf/saxon/expr/instruct/BlockIterator.html" title="class in net.sf.saxon.expr.instruct">BlockIterator</A>, <A HREF="../../../../net/sf/saxon/expr/CardinalityCheckingIterator.html" title="class in net.sf.saxon.expr">CardinalityCheckingIterator</A>, <A HREF="../../../../com/saxonica/bytecode/iter/CompiledBlockIterator.html" title="class in com.saxonica.bytecode.iter">CompiledBlockIterator</A>, <A HREF="../../../../com/saxonica/bytecode/iter/CompiledFilterIterator.html" title="class in com.saxonica.bytecode.iter">CompiledFilterIterator</A>, <A HREF="../../../../net/sf/saxon/expr/ContextMappingIterator.html" title="class in net.sf.saxon.expr">ContextMappingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/DifferenceEnumeration.html" title="class in net.sf.saxon.expr">DifferenceEnumeration</A>, <A HREF="../../../../net/sf/saxon/functions/DistinctValues.DistinctIterator.html" title="class in net.sf.saxon.functions">DistinctValues.DistinctIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/DocumentOrderIterator.html" title="class in net.sf.saxon.expr.sort">DocumentOrderIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/EmptyAxisIterator.html" title="class in net.sf.saxon.tree.iter">EmptyAxisIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/EmptyIterator.html" title="class in net.sf.saxon.tree.iter">EmptyIterator</A>, <A HREF="../../../../net/sf/saxon/expr/ErrorIterator.html" title="class in net.sf.saxon.expr">ErrorIterator</A>, <A HREF="../../../../net/sf/saxon/expr/EveryItemMappingIterator.html" title="class in net.sf.saxon.expr">EveryItemMappingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/FilterIterator.html" title="class in net.sf.saxon.expr">FilterIterator</A>, <A HREF="../../../../net/sf/saxon/expr/FilterIterator.NonNumeric.html" title="class in net.sf.saxon.expr">FilterIterator.NonNumeric</A>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupAdjacentIterator.html" title="class in net.sf.saxon.expr.sort">GroupAdjacentIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupByIterator.html" title="class in net.sf.saxon.expr.sort">GroupByIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupEndingIterator.html" title="class in net.sf.saxon.expr.sort">GroupEndingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupMatchingIterator.html" title="class in net.sf.saxon.expr.sort">GroupMatchingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/GroupStartingIterator.html" title="class in net.sf.saxon.expr.sort">GroupStartingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/HomogeneityCheckerIterator.html" title="class in net.sf.saxon.tree.iter">HomogeneityCheckerIterator</A>, <A HREF="../../../../net/sf/saxon/functions/IndexOf.IndexIterator.html" title="class in net.sf.saxon.functions">IndexOf.IndexIterator</A>, <A HREF="../../../../net/sf/saxon/functions/Insert.InsertIterator.html" title="class in net.sf.saxon.functions">Insert.InsertIterator</A>, <A HREF="../../../../net/sf/saxon/expr/IntersectionEnumeration.html" title="class in net.sf.saxon.expr">IntersectionEnumeration</A>, <A HREF="../../../../net/sf/saxon/expr/ItemMappingIterator.html" title="class in net.sf.saxon.expr">ItemMappingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/IteratorIterator.html" title="class in net.sf.saxon.tree.iter">IteratorIterator</A>, <A HREF="../../../../net/sf/saxon/functions/regex/JRegexIterator.html" title="class in net.sf.saxon.functions.regex">JRegexIterator</A>, <A HREF="../../../../net/sf/saxon/functions/regex/JTokenIterator.html" title="class in net.sf.saxon.functions.regex">JTokenIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/ListIterator.html" title="class in net.sf.saxon.tree.iter">ListIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/LookaheadIteratorImpl.html" title="class in net.sf.saxon.tree.iter">LookaheadIteratorImpl</A>, <A HREF="../../../../com/saxonica/stream/ManualIterator.html" title="class in com.saxonica.stream">ManualIterator</A>, <A HREF="../../../../net/sf/saxon/expr/MappingIterator.html" title="class in net.sf.saxon.expr">MappingIterator</A>, <A HREF="../../../../net/sf/saxon/value/MemoClosure.ProgressiveIterator.html" title="class in net.sf.saxon.value">MemoClosure.ProgressiveIterator</A>, <A HREF="../../../../com/saxonica/xsltextn/MergeEnumeration.html" title="class in com.saxonica.xsltextn">MergeEnumeration</A>, <A HREF="../../../../com/saxonica/xsltextn/MergeGroupingIterator.html" title="class in com.saxonica.xsltextn">MergeGroupingIterator</A>, <A HREF="../../../../com/saxonica/expr/ee/MultithreadedContextMappingIterator.html" title="class in com.saxonica.expr.ee">MultithreadedContextMappingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.AncestorEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.AncestorEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.AxisFilter.html" title="class in net.sf.saxon.tree.util">Navigator.AxisFilter</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.BaseEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.BaseEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.DescendantEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.DescendantEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.EmptyTextFilter.html" title="class in net.sf.saxon.tree.util">Navigator.EmptyTextFilter</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.FollowingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.FollowingEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/util/Navigator.PrecedingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.PrecedingEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/iter/NodeWrappingAxisIterator.html" title="class in net.sf.saxon.tree.iter">NodeWrappingAxisIterator</A>, <A HREF="../../../../com/saxonica/bytecode/iter/OneToOneMappingIterator.html" title="class in com.saxonica.bytecode.iter">OneToOneMappingIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/PrependIterator.html" title="class in net.sf.saxon.tree.iter">PrependIterator</A>, <A HREF="../../../../net/sf/saxon/expr/RangeIterator.html" title="class in net.sf.saxon.expr">RangeIterator</A>, <A HREF="../../../../net/sf/saxon/functions/Remove.RemoveIterator.html" title="class in net.sf.saxon.functions">Remove.RemoveIterator</A>, <A HREF="../../../../net/sf/saxon/expr/flwor/ReturnClauseIterator.html" title="class in net.sf.saxon.expr.flwor">ReturnClauseIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/ReverseArrayIterator.html" title="class in net.sf.saxon.tree.iter">ReverseArrayIterator</A>, <A HREF="../../../../net/sf/saxon/expr/ReverseRangeIterator.html" title="class in net.sf.saxon.expr">ReverseRangeIterator</A>, <A HREF="../../../../net/sf/saxon/evpull/SequenceComposer.html" title="class in net.sf.saxon.evpull">SequenceComposer</A>, <A HREF="../../../../com/saxonica/stream/SequenceExchanger.Consumer.html" title="class in com.saxonica.stream">SequenceExchanger.Consumer</A>, <A HREF="../../../../net/sf/saxon/tree/iter/SingleNodeIterator.html" title="class in net.sf.saxon.tree.iter">SingleNodeIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/SingletonIterator.html" title="class in net.sf.saxon.tree.iter">SingletonIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/SortedGroupIterator.html" title="class in net.sf.saxon.expr.sort">SortedGroupIterator</A>, <A HREF="../../../../net/sf/saxon/expr/sort/SortedIterator.html" title="class in net.sf.saxon.expr.sort">SortedIterator</A>, <A HREF="../../../../net/sf/saxon/expr/StringTokenIterator.html" title="class in net.sf.saxon.expr">StringTokenIterator</A>, <A HREF="../../../../net/sf/saxon/value/StringValue.CharacterIterator.html" title="class in net.sf.saxon.value">StringValue.CharacterIterator</A>, <A HREF="../../../../net/sf/saxon/expr/SubsequenceIterator.html" title="class in net.sf.saxon.expr">SubsequenceIterator</A>, <A HREF="../../../../net/sf/saxon/expr/TailIterator.html" title="class in net.sf.saxon.expr">TailIterator</A>, <A HREF="../../../../net/sf/saxon/expr/UnionEnumeration.html" title="class in net.sf.saxon.expr">UnionEnumeration</A>, <A HREF="../../../../net/sf/saxon/tree/iter/UnparsedTextIterator.html" title="class in net.sf.saxon.tree.iter">UnparsedTextIterator</A>, <A HREF="../../../../net/sf/saxon/tree/iter/UntypedAtomizingIterator.html" title="class in net.sf.saxon.tree.iter">UntypedAtomizingIterator</A>, <A HREF="../../../../net/sf/saxon/expr/ValueTailIterator.html" title="class in net.sf.saxon.expr">ValueTailIterator</A>, <A HREF="../../../../net/sf/saxon/tree/wrapper/VirtualCopy.VirtualCopier.html" title="class in net.sf.saxon.tree.wrapper">VirtualCopy.VirtualCopier</A>, <A HREF="../../../../net/sf/saxon/tree/wrapper/VirtualUntypedCopy.VirtualUntypedCopier.html" title="class in net.sf.saxon.tree.wrapper">VirtualUntypedCopy.VirtualUntypedCopier</A>, <A HREF="../../../../net/sf/saxon/tree/wrapper/WrappingIterator.html" title="class in net.sf.saxon.tree.wrapper">WrappingIterator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>SequenceIterator<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></B></DL>
</PRE>
<P>
A SequenceIterator is used to iterate over any XPath 2 sequence (of values or nodes).
To get the next item in a sequence, call next(); if this returns null, you've
reached the end of the sequence.
<p>
A SequenceIterator keeps track of the current Item and the current position.
The objects returned by the SequenceIterator will always be either nodes
(class NodeInfo) or singleton values (class AtomicValue): these are represented
collectively by the interface Item.
<p>
This interface forms part of the public Saxon API. The JavaDoc "since" flag is used from
release 8.4 onwards to indicate methods that are considered to be a stable part
of the API. Methods without a "since" flag should not be regarded as a stable part
of the API.
<p>
Note that the stability of this interface applies to classes that use the interface,
not to classes that implement it. The interface may be extended in future to add new methods.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>8.4</DD>
<DT><B>Author:</B></DT>
<DD>Michael H. Kay</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#GROUNDED">GROUNDED</A></B></CODE>
<BR>
Property value: the iterator is "grounded".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#LAST_POSITION_FINDER">LAST_POSITION_FINDER</A></B></CODE>
<BR>
Property value: the iterator knows the number of items that it will deliver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#LOOKAHEAD">LOOKAHEAD</A></B></CODE>
<BR>
Property value: the iterator knows whether there are more items still to come.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#close()">close</A></B>()</CODE>
<BR>
Close the iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#current()">current</A></B>()</CODE>
<BR>
Get the current value in the sequence (the one returned by the
most recent call on next()).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#getAnother()">getAnother</A></B>()</CODE>
<BR>
Get another SequenceIterator that iterates over the same items as the original,
but which is repositioned at the start of the sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#getProperties()">getProperties</A></B>()</CODE>
<BR>
Get properties of this iterator, as a bit-significant integer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#next()">next</A></B>()</CODE>
<BR>
Get the next item in the sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#position()">position</A></B>()</CODE>
<BR>
Get the current position.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="GROUNDED"><!-- --></A><H3>
GROUNDED</H3>
<PRE>
static final int <B>GROUNDED</B></PRE>
<DL>
<DD>Property value: the iterator is "grounded". This means that (a) the
iterator must be an instance of <A HREF="../../../../net/sf/saxon/tree/iter/GroundedIterator.html" title="interface in net.sf.saxon.tree.iter"><CODE>GroundedIterator</CODE></A>, and (b) the
implementation of the materialize() method must be efficient (in particular,
it should not involve the creation of new objects)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.SequenceIterator.GROUNDED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LAST_POSITION_FINDER"><!-- --></A><H3>
LAST_POSITION_FINDER</H3>
<PRE>
static final int <B>LAST_POSITION_FINDER</B></PRE>
<DL>
<DD>Property value: the iterator knows the number of items that it will deliver.
This means that (a) the iterator must be an instance of <A HREF="../../../../net/sf/saxon/expr/LastPositionFinder.html" title="interface in net.sf.saxon.expr"><CODE>LastPositionFinder</CODE></A>,
and (b) the implementation of the getLastPosition() method must be efficient (in particular,
it should take constant time, rather than time proportional to the length of the sequence)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.SequenceIterator.LAST_POSITION_FINDER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOOKAHEAD"><!-- --></A><H3>
LOOKAHEAD</H3>
<PRE>
static final int <B>LOOKAHEAD</B></PRE>
<DL>
<DD>Property value: the iterator knows whether there are more items still to come. This means
that (a) the iterator must be an instance of <A HREF="../../../../net/sf/saxon/tree/iter/LookaheadIterator.html" title="interface in net.sf.saxon.tree.iter"><CODE>LookaheadIterator</CODE></A>, and (b) the
implementation of the hasNext() method must be efficient (more efficient than the client doing
it)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.SequenceIterator.LOOKAHEAD">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="next()"><!-- --></A><H3>
next</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A> <B>next</B>()
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get the next item in the sequence. This method changes the state of the
iterator, in particular it affects the result of subsequent calls of
position() and current().
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the next item, or null if there are no more items. Once a call
on next() has returned null, no further calls should be made. The preferred
action for an iterator if subsequent calls on next() are made is to return
null again, and all implementations within Saxon follow this rule.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs retrieving the next item<DT><B>Since:</B></DT>
<DD>8.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="current()"><!-- --></A><H3>
current</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A> <B>current</B>()</PRE>
<DL>
<DD>Get the current value in the sequence (the one returned by the
most recent call on next()). This will be null before the first
call of next(). This method does not change the state of the iterator.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current item, the one most recently returned by a call on
next(). Returns null if next() has not been called, or if the end
of the sequence has been reached.<DT><B>Since:</B></DT>
<DD>8.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="position()"><!-- --></A><H3>
position</H3>
<PRE>
int <B>position</B>()</PRE>
<DL>
<DD>Get the current position. This will usually be zero before the first call
on next(), otherwise it will be the number of times that next() has
been called. Once next() has returned null, the preferred action is
for subsequent calls on position() to return -1, but not all existing
implementations follow this practice. (In particular, the EmptyIterator
is stateless, and always returns 0 as the value of position(), whether
or not next() has been called.)
<p>
This method does not change the state of the iterator.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current position, the position of the item returned by the
most recent call of next(). This is 1 after next() has been successfully
called once, 2 after it has been called twice, and so on. If next() has
never been called, the method returns zero. If the end of the sequence
has been reached, the value returned will always be <= 0; the preferred
value is -1.<DT><B>Since:</B></DT>
<DD>8.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
void <B>close</B>()</PRE>
<DL>
<DD>Close the iterator. This indicates to the supplier of the data that the client
does not require any more items to be delivered by the iterator. This may enable the
supplier to release resources. After calling close(), no further calls on the
iterator should be made; if further calls are made, the effect of such calls is undefined.
<p>(Currently, closing an iterator is important only when the data is being "pushed" in
another thread. Closing the iterator terminates that thread and means that it needs to do
no additional work. Indeed, failing to close the iterator may cause the push thread to hang
waiting for the buffer to be emptied.)</p>
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAnother()"><!-- --></A><H3>
getAnother</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="type parameter in SequenceIterator">T</A>> <B>getAnother</B>()
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get another SequenceIterator that iterates over the same items as the original,
but which is repositioned at the start of the sequence.
<p>
This method allows access to all the items in the sequence without disturbing the
current position of the iterator. Internally, its main use is in evaluating the last()
function.
<p>
This method does not change the state of the iterator.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a SequenceIterator that iterates over the same items,
positioned before the first item
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any error occurs<DT><B>Since:</B></DT>
<DD>8.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProperties()"><!-- --></A><H3>
getProperties</H3>
<PRE>
int <B>getProperties</B>()</PRE>
<DL>
<DD>Get properties of this iterator, as a bit-significant integer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the properties of this iterator. This will be some combination of
properties such as <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#GROUNDED"><CODE>GROUNDED</CODE></A>, <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#LAST_POSITION_FINDER"><CODE>LAST_POSITION_FINDER</CODE></A>,
and <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html#LOOKAHEAD"><CODE>LOOKAHEAD</CODE></A>. 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.<DT><B>Since:</B></DT>
<DD>8.6</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/SelectedElementsSpaceStrippingRule.StripRuleTarget.html" title="class in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/SpaceStrippingRule.html" title="interface in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/SequenceIterator.html" target="_top"><B>FRAMES</B></A>
<A HREF="SequenceIterator.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
