diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/EntityCursor.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/EntityCursor.html | 1820 |
1 files changed, 829 insertions, 991 deletions
diff --git a/docs/java/com/sleepycat/persist/EntityCursor.html b/docs/java/com/sleepycat/persist/EntityCursor.html index 33433833..f5dd1b3c 100644 --- a/docs/java/com/sleepycat/persist/EntityCursor.html +++ b/docs/java/com/sleepycat/persist/EntityCursor.html @@ -1,127 +1,122 @@ <!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_23) on Fri May 11 14:10:07 EDT 2012 --> -<TITLE> -EntityCursor (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:55 EST 2015 --> +<title>EntityCursor (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="EntityCursor (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= 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="class-use/EntityCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityCursor.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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="class-use/EntityCursor.html">Use</a></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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top">Frames</a></li> +<li><a href="EntityCursor.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.persist</FONT> -<BR> -Interface EntityCursor<V></H2> -<DL> -<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><V>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><V></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>EntityCursor<V></B><DT>extends <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><V></DL> -</PRE> - -<P> -Traverses entity values or key values and allows deleting or updating the +<div class="header"> +<div class="subTitle">com.sleepycat.persist</div> +<h2 title="Interface EntityCursor" class="title">Interface EntityCursor<V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><V>, java.lang.Iterable<V></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EntityCursor<V></span> +extends <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><V></pre> +<div class="block">Traverses entity values or key values and allows deleting or updating the entity at the current cursor position. The value type (V) is either an entity class or a key class, depending on how the cursor was opened. <p><code>EntityCursor</code> objects are <em>not</em> thread-safe. Cursors should be opened, used and closed by a single thread.</p> - <p>Cursors are opened using the <A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()"><CODE>EntityIndex.keys()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()"><CODE>EntityIndex.entities()</CODE></A> family of methods. These methods are available for - objects of any class that implements <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A>: <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>, <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>, and the indices returned by <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>SecondaryIndex.keysIndex</CODE></A> and <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A>. A <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist"><CODE>ForwardCursor</CODE></A>, which implements a subset of cursor operations, is also - available via the <A HREF="../../../com/sleepycat/persist/EntityJoin.html#keys()"><CODE>EntityJoin.keys()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityJoin.html#entities()"><CODE>EntityJoin.entities()</CODE></A> + <p>Cursors are opened using the <a href="../../../com/sleepycat/persist/EntityIndex.html#keys()"><code>EntityIndex.keys()</code></a> and <a href="../../../com/sleepycat/persist/EntityIndex.html#entities()"><code>EntityIndex.entities()</code></a> family of methods. These methods are available for + objects of any class that implements <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>: <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>, <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>, and the indices returned by <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>SecondaryIndex.keysIndex</code></a> and <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>SecondaryIndex.subIndex(SK)</code></a>. A <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist"><code>ForwardCursor</code></a>, which implements a subset of cursor operations, is also + available via the <a href="../../../com/sleepycat/persist/EntityJoin.html#keys()"><code>EntityJoin.keys()</code></a> and <a href="../../../com/sleepycat/persist/EntityJoin.html#entities()"><code>EntityJoin.entities()</code></a> methods.</p> <p>Values are always returned by a cursor in key order, where the key is - defined by the underlying <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A>. For example, a cursor on a - <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A> returns values ordered by secondary key, while an - index on a <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> or a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A> returns + defined by the underlying <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>. For example, a cursor on a + <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a> returns values ordered by secondary key, while an + index on a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> or a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>SecondaryIndex.subIndex(SK)</code></a> returns values ordered by primary key.</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, call <A HREF="../../../com/sleepycat/persist/EntityCursor.html#close()"><CODE>close()</CODE></A> in a finally block. For example, + face of exceptions, call <a href="../../../com/sleepycat/persist/EntityCursor.html#close()"><code>close()</code></a> in a finally block. For example, the following code traverses all Employee entities and closes the cursor whether or not an exception occurs:</p> @@ -160,11 +155,11 @@ Traverses entity values or key values and allows deleting or updating the <p>When it is opened, a cursor is not initially positioned on any value; in other words, it is uninitialized. Most methods in this interface initialize - the cursor position but certain methods, for example, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()"><CODE>current()</CODE></A> and - <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A>, throw <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalStateException</CODE></A> when called for an + the cursor position but certain methods, for example, <a href="../../../com/sleepycat/persist/EntityCursor.html#current()"><code>current()</code></a> and + <a href="../../../com/sleepycat/persist/EntityCursor.html#delete()"><code>delete()</code></a>, throw <code>IllegalStateException</code> when called for an uninitialized cursor.</p> - <p>Note that the <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev()"><CODE>prev()</CODE></A> methods return the first or + <p>Note that the <a href="../../../com/sleepycat/persist/EntityCursor.html#next()"><code>next()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prev()"><code>prev()</code></a> methods return the first or last value respectively for an uninitialized cursor. This allows the loop in the example above to be rewritten as follows:</p> @@ -181,7 +176,7 @@ Traverses entity values or key values and allows deleting or updating the <h3>Cursors and Iterators</h3> - <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#iterator()"><CODE>iterator()</CODE></A> method can be used to return a standard Java <code>Iterator</code> that returns the same values that the cursor returns. For + <p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#iterator()"><code>iterator()</code></a> method can be used to return a standard Java <code>Iterator</code> that returns the same values that the cursor returns. For example:</p> <pre class="code"> @@ -196,7 +191,7 @@ Traverses entity values or key values and allows deleting or updating the cursor.close(); }</pre> - <p>The <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><CODE>Iterable</CODE></A> interface is also extended by <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A> + <p>The <code>Iterable</code> interface is also extended by <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><code>EntityCursor</code></a> to allow using the cursor as the target of a Java "foreach" statement:</p> <pre class="code"> @@ -211,24 +206,24 @@ Traverses entity values or key values and allows deleting or updating the <p>The iterator uses the cursor directly, so any changes to the cursor position impact the iterator and vice versa. The iterator advances the - cursor by calling <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A> when <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util"><CODE>Iterator.hasNext()</CODE></A> or <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util"><CODE>Iterator.next()</CODE></A> is called. Because of this interaction, to keep things + cursor by calling <a href="../../../com/sleepycat/persist/EntityCursor.html#next()"><code>next()</code></a> when <code>Iterator.hasNext()</code> or <code>Iterator.next()</code> is called. Because of this interaction, to keep things simple it is best not to mix the use of an <code>EntityCursor</code> <code>Iterator</code> with the use of the <code>EntityCursor</code> traversal methods - such as <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A>, for a single <code>EntityCursor</code> object.</p> + such as <a href="../../../com/sleepycat/persist/EntityCursor.html#next()"><code>next()</code></a>, for a single <code>EntityCursor</code> object.</p> <h3>Key Ranges</h3> <p>A key range may be specified when opening the cursor, to restrict the key range of the cursor to a subset of the complete range of keys in the index. A <code>fromKey</code> and/or <code>toKey</code> parameter may be specified - when calling <A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(K, boolean, K, boolean)"><CODE>EntityIndex.keys(Object,boolean,Object,boolean)</CODE></A> or - <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(K, boolean, K, boolean)"><CODE>EntityIndex.entities(Object,boolean,Object,boolean)</CODE></A>. The key + when calling <a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)"><code>EntityIndex.keys(Object,boolean,Object,boolean)</code></a> or + <a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)"><code>EntityIndex.entities(Object,boolean,Object,boolean)</code></a>. The key arguments may be specified as inclusive or exclusive values.</p> <p>Whenever a cursor with a key range is moved, the key range bounds will be checked, and the cursor will never be positioned outside the range. The - <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A> cursor value is the first existing value in the range, and - the <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A> cursor value is the last existing value in the range. For + <a href="../../../com/sleepycat/persist/EntityCursor.html#first()"><code>first()</code></a> cursor value is the first existing value in the range, and + the <a href="../../../com/sleepycat/persist/EntityCursor.html#last()"><code>last()</code></a> cursor value is the last existing value in the range. For example, the following code traverses Employee entities with keys from 100 (inclusive) to 200 (exclusive):</p> @@ -244,26 +239,26 @@ Traverses entity values or key values and allows deleting or updating the <h3>Duplicate Keys</h3> - <p>When using a cursor for a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>, the keys in the index - may be non-unique (duplicates) if <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><CODE>SecondaryKey.relate()</CODE></A> is <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> or <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A>. For example, a <code>MANY_TO_ONE</code> <code>Employee.department</code> secondary key is non-unique because there are multiple - Employee entities with the same department key value. The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A>, - <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><CODE>prevDup()</CODE></A>, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><CODE>prevNoDup()</CODE></A> methods may be + <p>When using a cursor for a <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>, the keys in the index + may be non-unique (duplicates) if <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><code>SecondaryKey.relate()</code></a> is <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> or <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a>. For example, a <code>MANY_TO_ONE</code> <code>Employee.department</code> secondary key is non-unique because there are multiple + Employee entities with the same department key value. The <a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><code>nextDup()</code></a>, + <a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><code>prevDup()</code></a>, <a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><code>nextNoDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><code>prevNoDup()</code></a> methods may be used to control how non-unique keys are returned by the cursor.</p> - <p><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><CODE>prevDup()</CODE></A> return the next or previous value + <p><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><code>nextDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><code>prevDup()</code></a> return the next or previous value only if it has the same key as the current value, and null is returned when a different key is encountered. For example, these methods can be used to return all employees in a given department.</p> - <p><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><CODE>prevNoDup()</CODE></A> return the next or previous + <p><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><code>nextNoDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><code>prevNoDup()</code></a> return the next or previous value with a unique key, skipping over values that have the same key. For example, these methods can be used to return the first employee in each department.</p> <p>For example, the following code will find the first employee in each - department with <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> until it finds a department name that + department with <a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><code>nextNoDup()</code></a> until it finds a department name that matches a particular regular expression. For each matching department it - will find all employees in that department using <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A>.</p> + will find all employees in that department using <a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><code>nextDup()</code></a>.</p> <pre class="code"> <code>SecondaryIndex<String, Long, Employee></code> secondaryIndex = @@ -288,7 +283,7 @@ Traverses entity values or key values and allows deleting or updating the <h3>Updating and Deleting Entities with a Cursor</h3> - <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A> methods operate on the entity at + <p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><code>update(V)</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#delete()"><code>delete()</code></a> methods operate on the entity at the current cursor position. Cursors on any type of index may be used to delete entities. For example, the following code deletes all employees in departments which have names that match a particular regular expression:</p> @@ -318,12 +313,12 @@ Traverses entity values or key values and allows deleting or updating the deleting the entity at the current position. This is an important property of cursors, since without it you would not be able to easily delete while processing multiple values with a cursor. A cursor positioned on a deleted - entity is in a special state. In this state, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()"><CODE>current()</CODE></A> will return - null, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A> will return false, and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> will return + entity is in a special state. In this state, <a href="../../../com/sleepycat/persist/EntityCursor.html#current()"><code>current()</code></a> will return + null, <a href="../../../com/sleepycat/persist/EntityCursor.html#delete()"><code>delete()</code></a> will return false, and <a href="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><code>update(V)</code></a> will return false.</p> - <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> method is supported only if the value type is an - entity class (not a key class) and the underlying index is a <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>; in other words, for a cursor returned by one of the <CODE>BasicIndex.entities()</CODE> methods. For example, the following code changes all + <p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><code>update(V)</code></a> method is supported only if the value type is an + entity class (not a key class) and the underlying index is a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>; in other words, for a cursor returned by one of the <code>BasicIndex.entities()</code> methods. For example, the following code changes all employee names to uppercase:</p> <pre class="code"> @@ -337,919 +332,762 @@ Traverses entity values or key values and allows deleting or updating the } } finally { cursor.close(); - }</pre> -<P> - -<P> -<HR> - -<P> - + }</pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ========== 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="../../../com/sleepycat/persist/EntityCursor.html#close()">close</A></B>()</CODE> - -<BR> - Closes the cursor.</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="../../../com/sleepycat/persist/EntityCursor.html#count()">count</A></B>()</CODE> - -<BR> - Returns the number of values (duplicates) for the key at the cursor - position, or returns zero if all values for the key have been deleted.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()">current</A></B>()</CODE> - -<BR> - Returns the value at the cursor position, or null if the value at the - cursor position has been deleted.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#current(com.sleepycat.db.LockMode)">current</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Returns the value at the cursor position, or null if the value at the - cursor position has been deleted.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()">delete</A></B>()</CODE> - -<BR> - Deletes the entity at the cursor position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#dup()">dup</A></B>()</CODE> - -<BR> - Duplicates the cursor at the cursor position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()">first</A></B>()</CODE> - -<BR> - Moves the cursor to the first value and returns it, or returns null if - the cursor range is empty.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#first(com.sleepycat.db.LockMode)">first</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the first value and returns it, or returns null if - the cursor range is empty.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/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/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#iterator()">iterator</A></B>()</CODE> - -<BR> - Returns an iterator over the key range, starting with the value +<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/EntityCursor.html#close()">close</a></strong>()</code> +<div class="block">Closes the cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#count()">count</a></strong>()</code> +<div class="block">Returns the number of values (duplicates) for the key at the cursor + position, or returns zero if all values for the key have been deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#current()">current</a></strong>()</code> +<div class="block">Returns the value at the cursor position, or null if the value at the + cursor position has been deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#current(com.sleepycat.db.LockMode)">current</a></strong>(<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Returns the value at the cursor position, or null if the value at the + cursor position has been deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#delete()">delete</a></strong>()</code> +<div class="block">Deletes the entity at the cursor position.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#dup()">dup</a></strong>()</code> +<div class="block">Duplicates the cursor at the cursor position.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#first()">first</a></strong>()</code> +<div class="block">Moves the cursor to the first value and returns it, or returns null if + the cursor range is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#first(com.sleepycat.db.LockMode)">first</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 first value and returns it, or returns null if + the cursor range is empty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.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.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/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/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.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> - -<BR> - Returns an iterator over the key range, starting with the value + uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.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.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()">last</A></B>()</CODE> - -<BR> - Moves the cursor to the last value and returns it, or returns null if - the cursor range is empty.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#last(com.sleepycat.db.LockMode)">last</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the last value and returns it, or returns null if - the cursor range is empty.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()">next</A></B>()</CODE> - -<BR> - 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%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.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> - -<BR> - 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%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()">nextDup</A></B>()</CODE> - -<BR> - Moves the cursor to the next value with the same key (duplicate) and + uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#last()">last</a></strong>()</code> +<div class="block">Moves the cursor to the last value and returns it, or returns null if + the cursor range is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#last(com.sleepycat.db.LockMode)">last</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 last value and returns it, or returns null if + the cursor range is empty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.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="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.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> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup()">nextDup</a></strong>()</code> +<div class="block">Moves the cursor to the next value with the same key (duplicate) and returns it, or returns null if no more values are present for the key at - the current position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup(com.sleepycat.db.LockMode)">nextDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the next value with the same key (duplicate) and + the current position.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup(com.sleepycat.db.LockMode)">nextDup</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 with the same key (duplicate) and returns it, or returns null if no more values are present for the key at - the current position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()">nextNoDup</A></B>()</CODE> - -<BR> - Moves the cursor to the next value with a different key and returns it, - or returns null if there are no more unique keys in the cursor range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup(com.sleepycat.db.LockMode)">nextNoDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the next value with a different key and returns it, - or returns null if there are no more unique keys in the cursor range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev()">prev</A></B>()</CODE> - -<BR> - Moves the cursor to the previous value and returns it, or returns null - if there are no preceding values in the cursor range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev(com.sleepycat.db.LockMode)">prev</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the previous value and returns it, or returns null - if there are no preceding values in the cursor range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()">prevDup</A></B>()</CODE> - -<BR> - Moves the cursor to the previous value with the same key (duplicate) and + the current position.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()">nextNoDup</a></strong>()</code> +<div class="block">Moves the cursor to the next value with a different key and returns it, + or returns null if there are no more unique keys in the cursor range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup(com.sleepycat.db.LockMode)">nextNoDup</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 with a different key and returns it, + or returns null if there are no more unique keys in the cursor range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prev()">prev</a></strong>()</code> +<div class="block">Moves the cursor to the previous value and returns it, or returns null + if there are no preceding values in the cursor range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prev(com.sleepycat.db.LockMode)">prev</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 previous value and returns it, or returns null + if there are no preceding values in the cursor range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup()">prevDup</a></strong>()</code> +<div class="block">Moves the cursor to the previous value with the same key (duplicate) and returns it, or returns null if no preceding values are present for the - key at the current position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup(com.sleepycat.db.LockMode)">prevDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the previous value with the same key (duplicate) and + key at the current position.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup(com.sleepycat.db.LockMode)">prevDup</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 previous value with the same key (duplicate) and returns it, or returns null if no preceding values are present for the - key at the current position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()">prevNoDup</A></B>()</CODE> - -<BR> - Moves the cursor to the preceding value with a different key and returns + key at the current position.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()">prevNoDup</a></strong>()</code> +<div class="block">Moves the cursor to the preceding value with a different key and returns it, or returns null if there are no preceding unique keys in the cursor - range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup(com.sleepycat.db.LockMode)">prevNoDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Moves the cursor to the preceding value with a different key and returns + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup(com.sleepycat.db.LockMode)">prevNoDup</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 preceding value with a different key and returns it, or returns null if there are no preceding unique keys in the cursor - range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)">update</A></B>(<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> entity)</CODE> - -<BR> - Replaces the entity at the cursor position with the given entity.</TD> -</TR> -</TABLE> - -<P> - + range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityCursor.html#update(V)">update</a></strong>(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity)</code> +<div class="block">Replaces the entity at the cursor position with the given entity.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ 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="first()"><!-- --></A><H3> -first</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>first</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Moves the cursor to the first value and returns it, or returns null if - the cursor range is empty. - - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the first value, or null if the cursor range is empty. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="first(com.sleepycat.db.LockMode)"><!-- --></A><H3> -first</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>first</B>(<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> -<DL> -<DD>Moves the cursor to the first value and returns it, or returns null if +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="first()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>first</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> first() + 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 first value and returns it, or returns null if the cursor range is empty. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the first value, or null if the cursor range is empty. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> -<A NAME="last()"><!-- --></A><H3> -last</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>last</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Moves the cursor to the last value and returns it, or returns null if + <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 first value, or null if the cursor range is empty.</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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="first(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>first</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> first(<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 first value and returns it, or returns null if + the cursor range is empty.</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 first value, or null if the cursor range is empty.</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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="last()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>last</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> last() + 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 last value and returns it, or returns null if the cursor range is empty. - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the last value, or null if the cursor range is empty. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="last(com.sleepycat.db.LockMode)"><!-- --></A><H3> -last</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>last</B>(<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> -<DL> -<DD>Moves the cursor to the last value and returns it, or returns null if - the cursor range is empty. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the last value, or null if the cursor range is empty. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="next()"><!-- --></A><H3> -next</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>next</B>() - 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 + <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 last value, or null if the cursor range is empty.</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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="last(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>last</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> last(<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 last value and returns it, or returns null if + the cursor range is empty.</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 last value, or null if the cursor range is empty.</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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">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 is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. - - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the next value, or null if there are no more values in the - cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="next(com.sleepycat.db.LockMode)"><!-- --></A><H3> -next</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>next</B>(<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> -<DL> -<DD>Moves the cursor to the next value and returns it, or returns null + uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first()"><code>first()</code></a>. + + <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><a href="../../../com/sleepycat/persist/ForwardCursor.html#next()">next</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></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> - the base class for all BDB exceptions.</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/EntityCursor.html" title="type parameter in EntityCursor">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 is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the next value, or null if there are no more values in the - cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="nextDup()"><!-- --></A><H3> -nextDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextDup</B>() - 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 with the same key (duplicate) and + uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first()"><code>first()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd> +<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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="nextDup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextDup() + 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 with the same key (duplicate) and returns it, or returns null if no more values are present for the key at the current position. - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the next value with the same key, or null if no more values are - present for the key at the current position. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="nextDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> -nextDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextDup</B>(<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> -<DL> -<DD>Moves the cursor to the next value with the same key (duplicate) and + <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 with the same key, or null if no more values are + present for the key at the current position.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="nextDup(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextDup(<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 with the same key (duplicate) and returns it, or returns null if no more values are present for the key at - the current position. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the next value with the same key, or null if no more values are - present for the key at the current position. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="nextNoDup()"><!-- --></A><H3> -nextNoDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextNoDup</B>() - 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 with a different key and returns it, + the current position.</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 with the same key, or null if no more values are + present for the key at the current position.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="nextNoDup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextNoDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextNoDup() + 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 with a different key and returns it, or returns null if there are no more unique keys in the cursor range. - If the cursor is uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. - - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the next value with a different key, or null if there are no - more unique keys in the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="nextNoDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> -nextNoDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextNoDup</B>(<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> -<DL> -<DD>Moves the cursor to the next value with a different key and returns it, + If the cursor is uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first()"><code>first()</code></a>. + + <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 with a different key, or null if there are no + more unique keys 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="nextNoDup(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextNoDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextNoDup(<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 with a different key and returns it, or returns null if there are no more unique keys in the cursor range. - If the cursor is uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the next value with a different key, or null if there are no - more unique keys in the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prev()"><!-- --></A><H3> -prev</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prev</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Moves the cursor to the previous value and returns it, or returns null + If the cursor is uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first()"><code>first()</code></a>.</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 with a different key, or null if there are no + more unique keys 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prev()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prev</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prev() + 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 previous value and returns it, or returns null if there are no preceding values in the cursor range. If the cursor is - uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. - - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the previous value, or null if there are no preceding values in - the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prev(com.sleepycat.db.LockMode)"><!-- --></A><H3> -prev</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prev</B>(<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> -<DL> -<DD>Moves the cursor to the previous value and returns it, or returns null + uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#last()"><code>last()</code></a>. + + <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 previous value, or null if there are no preceding 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prev(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prev</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prev(<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 previous value and returns it, or returns null if there are no preceding values in the cursor range. If the cursor is - uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the previous value, or null if there are no preceding values in - the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prevDup()"><!-- --></A><H3> -prevDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevDup</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Moves the cursor to the previous value with the same key (duplicate) and + uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#last()"><code>last()</code></a>.</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 previous value, or null if there are no preceding 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prevDup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prevDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevDup() + 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 previous value with the same key (duplicate) and returns it, or returns null if no preceding values are present for the key at the current position. - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the previous value with the same key, or null if no preceding - values are present for the key at the current position. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prevDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> -prevDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevDup</B>(<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> -<DL> -<DD>Moves the cursor to the previous value with the same key (duplicate) and + <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 previous value with the same key, or null if no preceding + values are present for the key at the current position.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prevDup(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prevDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevDup(<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 previous value with the same key (duplicate) and returns it, or returns null if no preceding values are present for the - key at the current position. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the previous value with the same key, or null if no preceding - values are present for the key at the current position. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prevNoDup()"><!-- --></A><H3> -prevNoDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevNoDup</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Moves the cursor to the preceding value with a different key and returns + key at the current position.</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 previous value with the same key, or null if no preceding + values are present for the key at the current position.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prevNoDup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prevNoDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevNoDup() + 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 preceding value with a different key and returns it, or returns null if there are no preceding unique keys in the cursor range. If the cursor is uninitialized, this method is equivalent to - <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. - - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the previous value with a different key, or null if there are no - preceding unique keys in the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="prevNoDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> -prevNoDup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevNoDup</B>(<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> -<DL> -<DD>Moves the cursor to the preceding value with a different key and returns + <a href="../../../com/sleepycat/persist/EntityCursor.html#last()"><code>last()</code></a>. + + <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 previous value with a different key, or null if there are no + preceding unique keys 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="prevNoDup(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prevNoDup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevNoDup(<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 preceding value with a different key and returns it, or returns null if there are no preceding unique keys in the cursor range. If the cursor is uninitialized, this method is equivalent to - <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the previous value with a different key, or null if there are no - preceding unique keys in the cursor range. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="current()"><!-- --></A><H3> -current</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>current</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns the value at the cursor position, or null if the value at the + <a href="../../../com/sleepycat/persist/EntityCursor.html#last()"><code>last()</code></a>.</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 previous value with a different key, or null if there are no + preceding unique keys 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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="current()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>current</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> current() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns the value at the cursor position, or null if the value at the cursor position has been deleted. - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the value at the cursor position, or null if it has been - deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="current(com.sleepycat.db.LockMode)"><!-- --></A><H3> -current</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>current</B>(<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> -<DL> -<DD>Returns the value at the cursor position, or null if the value at the - cursor position has been deleted. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the value at the cursor position, or null if it has been - deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="count()"><!-- --></A><H3> -count</H3> -<PRE> -int <B>count</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns the number of values (duplicates) for the key at the cursor + <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 value at the cursor position, or null if it has been + deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="current(com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>current</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> current(<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">Returns the value at the cursor position, or null if the value at the + cursor position has been deleted.</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 value at the cursor position, or null if it has been + deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>int count() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns the number of values (duplicates) for the key at the cursor position, or returns zero if all values for the key have been deleted. Returns one or zero if the underlying index has unique keys. - <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the number of duplicates, or zero if all values for the current - key have been deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="iterator()"><!-- --></A><H3> -iterator</H3> -<PRE> -<A HREF="http://download.oracle.com/javase/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/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>iterator</B>()</PRE> -<DL> -<DD>Returns an iterator over the key range, starting with the 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 number of duplicates, or zero if all values for the current + key have been deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</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/EntityCursor.html" title="type parameter in EntityCursor">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> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/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://download.oracle.com/javase/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/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the iterator.</DL> -</DD> -</DL> -<HR> - -<A NAME="iterator(com.sleepycat.db.LockMode)"><!-- --></A><H3> -iterator</H3> -<PRE> -<A HREF="http://download.oracle.com/javase/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/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>iterator</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</PRE> -<DL> -<DD>Returns an iterator over the key range, starting with the value + <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><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">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/EntityCursor.html" title="type parameter in EntityCursor">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. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><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><B>Returns:</B><DD>the iterator.</DL> -</DD> -</DL> -<HR> - -<A NAME="update(java.lang.Object)"><!-- --></A><A NAME="update(V)"><!-- --></A><H3> -update</H3> -<PRE> -boolean <B>update</B>(<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> entity) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Replaces the entity at the cursor position with the given entity. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>entity</CODE> - the entity to replace the entity at the current position. -<DT><B>Returns:</B><DD>true if successful or false if the entity at the current - position was previously deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the index is read only or if - the value type is not an entity type. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="delete()"><!-- --></A><H3> -delete</H3> -<PRE> -boolean <B>delete</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Deletes the entity at the cursor position. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>true if successful or false if the entity at the current - position has been deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the index is read only. -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="dup()"><!-- --></A><H3> -dup</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>dup</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Duplicates the cursor at the cursor position. The returned cursor will + uninitialized.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd> +<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="update(java.lang.Object)"> +<!-- --> +</a><a name="update(V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>update</h4> +<pre>boolean update(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Replaces the entity at the cursor position with the given entity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - the entity to replace the entity at the current position.</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if successful or false if the entity at the current + position was previously deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only or if + the value type is not an entity type.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="delete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>boolean delete() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Deletes the entity at the cursor position.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if successful or false if the entity at the current + position has been deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only.</dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="dup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dup</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>> dup() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Duplicates the cursor at the cursor position. The returned cursor will be initially positioned at the same position as this current cursor, and - will inherit this cursor's <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> and <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><CODE>CursorConfig</CODE></A>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the duplicated cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="close()"><!-- --></A><H3> -close</H3> -<PRE> -void <B>close</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Closes the cursor. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> + will inherit this cursor's <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> and <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><code>CursorConfig</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the duplicated cursor.</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> - the base class for all BDB exceptions.</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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></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> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= 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="class-use/EntityCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityCursor.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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="class-use/EntityCursor.html">Use</a></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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top">Frames</a></li> +<li><a href="EntityCursor.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</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 ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |