Edit File - File Manager

Edit File: ForwardCursor.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
ForwardCursor (Oracle - Berkeley DB Java API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="ForwardCursor (Oracle - Berkeley DB Java API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardCursor.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Berkeley DB version 4.7.25
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html?com/sleepycat/persist/ForwardCursor.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="ForwardCursor.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

com.sleepycat.persist
 
Interface ForwardCursor&lt;V&gt;</H2>
<DL>
<DT>All Superinterfaces: <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;V&gt;</DD>
</DL>
<DL>
<DT>All Known Subinterfaces: <DD><A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A>&lt;V&gt;</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface ForwardCursor&lt;V&gt;<DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;V&gt;</DL>
</PRE>

Cursor operations limited to traversing forward. See <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A>
 for general information on cursors.

<code>ForwardCursor</code> objects are not thread-safe. Cursors
 should be opened, used and closed by a single thread.

WARNING: Cursors must always be closed to prevent resource leaks
 which could lead to the index becoming unusable or cause an
 <code>OutOfMemoryError</code>. To ensure that a cursor is closed in the
 face of exceptions, close it in a finally block.

<HR>

<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">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the cursor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>&gt;</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an iterator over the key range, starting with the value
 following the current position or at the first value if the cursor is
 uninitialized.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>&gt;</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</A>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Moves the cursor to the next value and returns it, or returns null
 if there are no more values in the cursor range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A></CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</A>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>

<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">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="next()"></A><H3>
next</H3>
<PRE>
<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A> next()
 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Moves the cursor to the next value and returns it, or returns null
 if there are no more values in the cursor range. If the cursor is
 uninitialized, this method returns the first value.

<A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the next value, or null if there are no more values in the
 cursor range.
<DT>Throws:
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="next(com.sleepycat.db.LockMode)"></A><H3>
next</H3>
<PRE>
<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A> next(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Moves the cursor to the next value and returns it, or returns null
 if there are no more values in the cursor range. If the cursor is
 uninitialized, this method returns the first value.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to
 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>.
<DT>Returns:<DD>the next value, or null if there are no more values in the
 cursor range.
<DT>Throws:
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="iterator()"></A><H3>
iterator</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>&gt; iterator()</PRE>
<DL>
<DD>Returns an iterator over the key range, starting with the value
 following the current position or at the first value if the cursor is
 uninitialized.

<A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html#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" title="class or interface in java.lang">Iterable</A>&lt;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>&gt;</CODE></DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the iterator.</DL>
</DD>
</DL>
<HR>

<A NAME="iterator(com.sleepycat.db.LockMode)"></A><H3>
iterator</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</A>&gt; iterator(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</PRE>
<DL>
<DD>Returns an iterator over the key range, starting with the value
 following the current position or at the first value if the cursor is
 uninitialized.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>lockMode</CODE> - the lock mode to use for all operations performed
 using the iterator, or null to use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>.
<DT>Returns:<DD>the iterator.</DL>
</DD>
</DL>
<HR>

<A NAME="close()"></A><H3>
close</H3>
<PRE>
void close()
 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Closes the cursor.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Throws:
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>

<HR>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardCursor.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Berkeley DB version 4.7.25
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

Back to File Manager