1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:50 EDT 2010 --> 6<TITLE> 7ForwardCursor (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="ForwardCursor (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/persist/ForwardCursor.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ForwardCursor.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.persist</FONT> 92<BR> 93Interface ForwardCursor<V></H2> 94<DL> 95<DT><B>All Superinterfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><V></DD> 96</DL> 97<DL> 98<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><V></DD> 99</DL> 100<HR> 101<DL> 102<DT><PRE>public interface <B>ForwardCursor<V></B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><V></DL> 103</PRE> 104 105<P> 106Cursor operations limited to traversing forward. See <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A> 107 for general information on cursors. 108 109 <p><code>ForwardCursor</code> objects are <em>not</em> thread-safe. Cursors 110 should be opened, used and closed by a single thread.</p> 111 112 <p><em>WARNING:</em> Cursors must always be closed to prevent resource leaks 113 which could lead to the index becoming unusable or cause an 114 <code>OutOfMemoryError</code>. To ensure that a cursor is closed in the 115 face of exceptions, close it in a finally block.</p> 116<P> 117 118<P> 119<HR> 120 121<P> 122 123<!-- ========== METHOD SUMMARY =========== --> 124 125<A NAME="method_summary"><!-- --></A> 126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 128<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 129<B>Method Summary</B></FONT></TH> 130</TR> 131<TR BGCOLOR="white" CLASS="TableRowColor"> 132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 133<CODE> void</CODE></FONT></TD> 134<TD><CODE><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</A></B>()</CODE> 135 136<BR> 137 Closes the cursor.</TD> 138</TR> 139<TR BGCOLOR="white" CLASS="TableRowColor"> 140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 141<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>></CODE></FONT></TD> 142<TD><CODE><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</A></B>()</CODE> 143 144<BR> 145 Returns an iterator over the key range, starting with the value 146 following the current position or at the first value if the cursor is 147 uninitialized.</TD> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 151<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>></CODE></FONT></TD> 152<TD><CODE><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 153 154<BR> 155 Returns an iterator over the key range, starting with the value 156 following the current position or at the first value if the cursor is 157 uninitialized.</TD> 158</TR> 159<TR BGCOLOR="white" CLASS="TableRowColor"> 160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 161<CODE> <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A></CODE></FONT></TD> 162<TD><CODE><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next()">next</A></B>()</CODE> 163 164<BR> 165 Moves the cursor to the next value and returns it, or returns null 166 if there are no more values in the cursor range.</TD> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170<CODE> <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A></CODE></FONT></TD> 171<TD><CODE><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 172 173<BR> 174 Moves the cursor to the next value and returns it, or returns null 175 if there are no more values in the cursor range.</TD> 176</TR> 177</TABLE> 178 179<P> 180 181<!-- ============ METHOD DETAIL ========== --> 182 183<A NAME="method_detail"><!-- --></A> 184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 186<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 187<B>Method Detail</B></FONT></TH> 188</TR> 189</TABLE> 190 191<A NAME="next()"><!-- --></A><H3> 192next</H3> 193<PRE> 194<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A> <B>next</B>() 195 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 196<DL> 197<DD>Moves the cursor to the next value and returns it, or returns null 198 if there are no more values in the cursor range. If the cursor is 199 uninitialized, this method returns the first value. 200 201 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 202<P> 203<DD><DL> 204</DL> 205</DD> 206<DD><DL> 207 208<DT><B>Returns:</B><DD>the next value, or null if there are no more values in the 209 cursor range. 210<DT><B>Throws:</B> 211<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 212</DD> 213</DL> 214<HR> 215 216<A NAME="next(com.sleepycat.db.LockMode)"><!-- --></A><H3> 217next</H3> 218<PRE> 219<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A> <B>next</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 220 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 221<DL> 222<DD>Moves the cursor to the next value and returns it, or returns null 223 if there are no more values in the cursor range. If the cursor is 224 uninitialized, this method returns the first value. 225<P> 226<DD><DL> 227</DL> 228</DD> 229<DD><DL> 230<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 231 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 232<DT><B>Returns:</B><DD>the next value, or null if there are no more values in the 233 cursor range. 234<DT><B>Throws:</B> 235<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 236</DD> 237</DL> 238<HR> 239 240<A NAME="iterator()"><!-- --></A><H3> 241iterator</H3> 242<PRE> 243<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>> <B>iterator</B>()</PRE> 244<DL> 245<DD>Returns an iterator over the key range, starting with the value 246 following the current position or at the first value if the cursor is 247 uninitialized. 248 249 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 250<P> 251<DD><DL> 252<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>></CODE></DL> 253</DD> 254<DD><DL> 255 256<DT><B>Returns:</B><DD>the iterator.</DL> 257</DD> 258</DL> 259<HR> 260 261<A NAME="iterator(com.sleepycat.db.LockMode)"><!-- --></A><H3> 262iterator</H3> 263<PRE> 264<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>> <B>iterator</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</PRE> 265<DL> 266<DD>Returns an iterator over the key range, starting with the value 267 following the current position or at the first value if the cursor is 268 uninitialized. 269<P> 270<DD><DL> 271</DL> 272</DD> 273<DD><DL> 274<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for all operations performed 275 using the iterator, or null to use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 276<DT><B>Returns:</B><DD>the iterator.</DL> 277</DD> 278</DL> 279<HR> 280 281<A NAME="close()"><!-- --></A><H3> 282close</H3> 283<PRE> 284void <B>close</B>() 285 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 286<DL> 287<DD>Closes the cursor. 288<P> 289<DD><DL> 290</DL> 291</DD> 292<DD><DL> 293 294<DT><B>Throws:</B> 295<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 296</DD> 297</DL> 298<!-- ========= END OF CLASS DATA ========= --> 299<HR> 300 301 302<!-- ======= START OF BOTTOM NAVBAR ====== --> 303<A NAME="navbar_bottom"><!-- --></A> 304<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 305<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 306<TR> 307<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 308<A NAME="navbar_bottom_firstrow"><!-- --></A> 309<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 310 <TR ALIGN="center" VALIGN="top"> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 313 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 319 </TR> 320</TABLE> 321</TD> 322<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 323<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 324</TD> 325</TR> 326 327<TR> 328<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 329 <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> 330 <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 331<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 332 <A HREF="../../../index.html?com/sleepycat/persist/ForwardCursor.html" target="_top"><B>FRAMES</B></A> 333 <A HREF="ForwardCursor.html" target="_top"><B>NO FRAMES</B></A> 334 <SCRIPT type="text/javascript"> 335 <!-- 336 if(window==top) { 337 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 338 } 339 //--> 340</SCRIPT> 341<NOSCRIPT> 342 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 343</NOSCRIPT> 344 345 346</FONT></TD> 347</TR> 348<TR> 349<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 350 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 352DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 353</TR> 354</TABLE> 355<A NAME="skip-navbar_bottom"></A> 356<!-- ======== END OF BOTTOM NAVBAR ======= --> 357 358<HR> 359<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 360</BODY> 361</HTML> 362