<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 09 22:45:26 GMT 2014 -->
<title>ForwardCursor</title>
<meta name="date" content="2014-01-09">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ForwardCursor";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/ForwardCursor.html" target="_top">Frames</a></li>
<li><a href="ForwardCursor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.persist</div>
<h2 title="Interface ForwardCursor" class="title">Interface ForwardCursor<V></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Iterable<V></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><V></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ForwardCursor<V></span>
extends java.lang.Iterable<V></pre>
<div class="block">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.
<p><code>ForwardCursor</code> objects are <em>not</em> thread-safe. Cursors
should be opened, used and closed by a single thread.</p>
<p><em>WARNING:</em> 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.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</a></strong>()</code>
<div class="block">Closes the cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</a></strong>()</code>
<div class="block">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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</a></strong>(<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code>
<div class="block">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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/ForwardCursor.html#next()">next</a></strong>()</code>
<div class="block">Moves the cursor to the next value and returns it, or returns null
if there are no more values in the cursor range.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</a></strong>(<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code>
<div class="block">Moves the cursor to the next value and returns it, or returns null
if there are no more values in the cursor range.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<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>
<div class="block">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.
<p><a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the next value, or null if there are no more values in the
cursor range.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="next(com.sleepycat.db.LockMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<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> lockMode)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the next value, or null if there are no more values in the
cursor range.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>java.util.Iterator<<a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a>> iterator()</pre>
<div class="block">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.
<p><a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the iterator.</dd></dl>
</li>
</ul>
<a name="iterator(com.sleepycat.db.LockMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>java.util.Iterator<<a href="../../../com/sleepycat/persist/ForwardCursor.html" title="type parameter in ForwardCursor">V</a>> iterator(<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the iterator.</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void close()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Closes the cursor.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/ForwardCursor.html" target="_top">Frames</a></li>
<li><a href="ForwardCursor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
