diff options
Diffstat (limited to 'docs/java/com/sleepycat/collections/StoredIterator.html')
| -rw-r--r-- | docs/java/com/sleepycat/collections/StoredIterator.html | 1248 |
1 files changed, 590 insertions, 658 deletions
diff --git a/docs/java/com/sleepycat/collections/StoredIterator.html b/docs/java/com/sleepycat/collections/StoredIterator.html index ed8a5ec6..7962379e 100644 --- a/docs/java/com/sleepycat/collections/StoredIterator.html +++ b/docs/java/com/sleepycat/collections/StoredIterator.html @@ -1,541 +1,485 @@ <!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> -StoredIterator (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:54 EST 2015 --> +<title>StoredIterator (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="StoredIterator (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/StoredIterator.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/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/collections/StoredIterator.html" target="_top"><B>FRAMES</B></A> - <A HREF="StoredIterator.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/StoredIterator.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/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/collections/StoredIterator.html" target="_top">Frames</a></li> +<li><a href="StoredIterator.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.collections</FONT> -<BR> -Class StoredIterator<E></H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.collections.StoredIterator<E></B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <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><E>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><E></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>StoredIterator<E></B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><E>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> -</PRE> - -<P> -The Iterator returned by all stored collections. - - <p>While in general this class conforms to the <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"><CODE>Iterator</CODE></A> interface, +<div class="header"> +<div class="subTitle">com.sleepycat.collections</div> +<h2 title="Class StoredIterator" class="title">Class StoredIterator<E></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.collections.StoredIterator<E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Cloneable, java.util.Iterator<E>, java.util.ListIterator<E></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StoredIterator<E></span> +extends java.lang.Object +implements java.util.ListIterator<E>, java.lang.Cloneable</pre> +<div class="block">The Iterator returned by all stored collections. + + <p>While in general this class conforms to the <code>Iterator</code> interface, it is important to note that all iterators for stored collections must be - explicitly closed with <A HREF="../../../com/sleepycat/collections/StoredIterator.html#close()"><CODE>close()</CODE></A>. The static method <A HREF="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)"><CODE>close(java.util.Iterator)</CODE></A> allows calling close for all iterators without + explicitly closed with <a href="../../../com/sleepycat/collections/StoredIterator.html#close()"><code>close()</code></a>. The static method <a href="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)"><code>close(java.util.Iterator)</code></a> allows calling close for all iterators without harm to iterators that are not from stored collections, and also avoids casting. If a stored iterator is not closed, unpredictable behavior including process death may result.</p> - <p>This class implements the <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"><CODE>Iterator</CODE></A> interface for all stored - iterators. It also implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util"><CODE>ListIterator</CODE></A> because some list - iterator methods apply to all stored iterators, for example, <A HREF="../../../com/sleepycat/collections/StoredIterator.html#previous()"><CODE>previous()</CODE></A> and <A HREF="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious()"><CODE>hasPrevious()</CODE></A>. Other list iterator methods are always + <p>This class implements the <code>Iterator</code> interface for all stored + iterators. It also implements <code>ListIterator</code> because some list + iterator methods apply to all stored iterators, for example, <a href="../../../com/sleepycat/collections/StoredIterator.html#previous()"><code>previous()</code></a> and <a href="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious()"><code>hasPrevious()</code></a>. Other list iterator methods are always supported for lists, but for other types of collections are only supported - under certain conditions. See <A HREF="../../../com/sleepycat/collections/StoredIterator.html#nextIndex()"><CODE>nextIndex()</CODE></A>, <A HREF="../../../com/sleepycat/collections/StoredIterator.html#previousIndex()"><CODE>previousIndex()</CODE></A>, - <A HREF="../../../com/sleepycat/collections/StoredIterator.html#add(E)"><CODE>add(E)</CODE></A> and <A HREF="../../../com/sleepycat/collections/StoredIterator.html#set(E)"><CODE>set(E)</CODE></A> for details.</p> + under certain conditions. See <a href="../../../com/sleepycat/collections/StoredIterator.html#nextIndex()"><code>nextIndex()</code></a>, <a href="../../../com/sleepycat/collections/StoredIterator.html#previousIndex()"><code>previousIndex()</code></a>, + <a href="../../../com/sleepycat/collections/StoredIterator.html#add(E)"><code>add(E)</code></a> and <a href="../../../com/sleepycat/collections/StoredIterator.html#set(E)"><code>set(E)</code></a> for details.</p> <p>In addition, this class provides the following methods for stored collection iterators only. Note that the use of these methods is not compatible with the standard Java collections interface.</p> <ul> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#close()"><CODE>close()</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)"><CODE>close(Iterator)</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#count()"><CODE>count()</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#getCollection()"><CODE>getCollection()</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#setReadModifyWrite(boolean)"><CODE>setReadModifyWrite(boolean)</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredIterator.html#isReadModifyWrite()"><CODE>isReadModifyWrite()</CODE></A></li> - </ul> -<P> - -<P> -<HR> - -<P> - + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#close()"><code>close()</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)"><code>close(Iterator)</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#count()"><code>count()</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#getCollection()"><code>getCollection()</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#setReadModifyWrite(boolean)"><code>setReadModifyWrite(boolean)</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredIterator.html#isReadModifyWrite()"><code>isReadModifyWrite()</code></a></li> + </ul></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/collections/StoredIterator.html#add(E)">add</A></B>(<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> value)</CODE> - -<BR> - Inserts the specified element into the list or inserts a duplicate into - other types of collections (optional operation).</TD> -</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/collections/StoredIterator.html#close()">close</A></B>()</CODE> - -<BR> - Closes this iterator.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)">close</A></B>(<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><?> i)</CODE> - -<BR> - Closes the given iterator using <A HREF="../../../com/sleepycat/collections/StoredIterator.html#close()"><CODE>close()</CODE></A> if it is a <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><CODE>StoredIterator</CODE></A>.</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/collections/StoredIterator.html#count()">count</A></B>()</CODE> - -<BR> - Returns the number of elements having the same key value as the key - value of the element last returned by next() or previous().</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredIterator.html#getCollection()">getCollection</A></B>()</CODE> - -<BR> - Returns the collection associated with this iterator.</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/collections/StoredIterator.html#hasNext()">hasNext</A></B>()</CODE> - -<BR> - Returns true if this iterator has more elements when traversing in the - forward direction.</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/collections/StoredIterator.html#hasPrevious()">hasPrevious</A></B>()</CODE> - -<BR> - Returns true if this iterator has more elements when traversing in the - reverse direction.</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/collections/StoredIterator.html#isReadModifyWrite()">isReadModifyWrite</A></B>()</CODE> - -<BR> - Returns whether write-locks will be obtained when reading with this - cursor.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredIterator.html#next()">next</A></B>()</CODE> - -<BR> - Returns the next element in the iteration.</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/collections/StoredIterator.html#nextIndex()">nextIndex</A></B>()</CODE> - -<BR> - Returns the index of the element that would be returned by a subsequent - call to next.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredIterator.html#previous()">previous</A></B>()</CODE> - -<BR> - Returns the next element in the iteration.</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/collections/StoredIterator.html#previousIndex()">previousIndex</A></B>()</CODE> - -<BR> - Returns the index of the element that would be returned by a subsequent - call to previous.</TD> -</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/collections/StoredIterator.html#remove()">remove</A></B>()</CODE> - -<BR> - Removes the last element that was returned by next or previous (optional - operation).</TD> -</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/collections/StoredIterator.html#set(E)">set</A></B>(<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> value)</CODE> - -<BR> - Replaces the last element returned by next or previous with the - specified element (optional operation).</TD> -</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/collections/StoredIterator.html#setReadModifyWrite(boolean)">setReadModifyWrite</A></B>(boolean lockForWrite)</CODE> - -<BR> - Changes whether write-locks will be obtained when reading with this - cursor.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<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/collections/StoredIterator.html#add(E)">add</a></strong>(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> value)</code> +<div class="block">Inserts the specified element into the list or inserts a duplicate into + other types of collections (optional operation).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#close()">close</a></strong>()</code> +<div class="block">Closes this iterator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#close(java.util.Iterator)">close</a></strong>(java.util.Iterator<?> i)</code> +<div class="block">Closes the given iterator using <a href="../../../com/sleepycat/collections/StoredIterator.html#close()"><code>close()</code></a> if it is a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#count()">count</a></strong>()</code> +<div class="block">Returns the number of elements having the same key value as the key + value of the element last returned by next() or previous().</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a><<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#getCollection()">getCollection</a></strong>()</code> +<div class="block">Returns the collection associated with this iterator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this iterator has more elements when traversing in the + forward direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious()">hasPrevious</a></strong>()</code> +<div class="block">Returns true if this iterator has more elements when traversing in the + reverse direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#isReadModifyWrite()">isReadModifyWrite</a></strong>()</code> +<div class="block">Returns whether write-locks will be obtained when reading with this + cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element in the iteration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#nextIndex()">nextIndex</a></strong>()</code> +<div class="block">Returns the index of the element that would be returned by a subsequent + call to next.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#previous()">previous</a></strong>()</code> +<div class="block">Returns the next element in the iteration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#previousIndex()">previousIndex</a></strong>()</code> +<div class="block">Returns the index of the element that would be returned by a subsequent + call to previous.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#remove()">remove</a></strong>()</code> +<div class="block">Removes the last element that was returned by next or previous (optional + operation).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#set(E)">set</a></strong>(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> value)</code> +<div class="block">Replaces the last element returned by next or previous with the + specified element (optional operation).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredIterator.html#setReadModifyWrite(boolean)">setReadModifyWrite</a></strong>(boolean lockForWrite)</code> +<div class="block">Changes whether write-locks will be obtained when reading with this + cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</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="close(java.util.Iterator)"><!-- --></A><H3> -close</H3> -<PRE> -public static void <B>close</B>(<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><?> i)</PRE> -<DL> -<DD>Closes the given iterator using <A HREF="../../../com/sleepycat/collections/StoredIterator.html#close()"><CODE>close()</CODE></A> if it is a <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><CODE>StoredIterator</CODE></A>. If the given iterator is not a <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><CODE>StoredIterator</CODE></A>, - this method does nothing. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>i</CODE> - is the iterator to close. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="isReadModifyWrite()"><!-- --></A><H3> -isReadModifyWrite</H3> -<PRE> -public final boolean <B>isReadModifyWrite</B>()</PRE> -<DL> -<DD>Returns whether write-locks will be obtained when reading with this +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="close(java.util.Iterator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public static void close(java.util.Iterator<?> i)</pre> +<div class="block">Closes the given iterator using <a href="../../../com/sleepycat/collections/StoredIterator.html#close()"><code>close()</code></a> if it is a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a>. If the given iterator is not a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a>, + this method does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - is the iterator to close.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C edition).</dd></dl> +</li> +</ul> +<a name="isReadModifyWrite()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReadModifyWrite</h4> +<pre>public final boolean isReadModifyWrite()</pre> +<div class="block">Returns whether write-locks will be obtained when reading with this cursor. Obtaining write-locks can prevent deadlocks when reading and then - modifying data. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the write-lock setting.</DL> -</DD> -</DL> -<HR> - -<A NAME="setReadModifyWrite(boolean)"><!-- --></A><H3> -setReadModifyWrite</H3> -<PRE> -public void <B>setReadModifyWrite</B>(boolean lockForWrite)</PRE> -<DL> -<DD>Changes whether write-locks will be obtained when reading with this + modifying data.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the write-lock setting.</dd></dl> +</li> +</ul> +<a name="setReadModifyWrite(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadModifyWrite</h4> +<pre>public void setReadModifyWrite(boolean lockForWrite)</pre> +<div class="block">Changes whether write-locks will be obtained when reading with this cursor. Obtaining write-locks can prevent deadlocks when reading and then - modifying data. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>lockForWrite</CODE> - the write-lock setting.</DL> -</DD> -</DL> -<HR> - -<A NAME="hasNext()"><!-- --></A><H3> -hasNext</H3> -<PRE> -public boolean <B>hasNext</B>()</PRE> -<DL> -<DD>Returns true if this iterator has more elements when traversing in the + modifying data.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lockForWrite</code> - the write-lock setting.</dd></dl> +</li> +</ul> +<a name="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext()</pre> +<div class="block">Returns true if this iterator has more elements when traversing in the forward direction. False is returned if the iterator has been closed. - This method conforms to the <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> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><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">hasNext</A></CODE> in interface <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/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#hasNext()" title="class or interface in java.util">hasNext</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>whether <A HREF="../../../com/sleepycat/collections/StoredIterator.html#next()"><CODE>next()</CODE></A> will succeed. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="hasPrevious()"><!-- --></A><H3> -hasPrevious</H3> -<PRE> -public boolean <B>hasPrevious</B>()</PRE> -<DL> -<DD>Returns true if this iterator has more elements when traversing in the + This method conforms to the <code>Iterator.hasNext()</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hasNext</code> in interface <code>java.util.Iterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>hasNext</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>whether <a href="../../../com/sleepycat/collections/StoredIterator.html#next()"><code>next()</code></a> will succeed.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C edition).</dd></dl> +</li> +</ul> +<a name="hasPrevious()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasPrevious</h4> +<pre>public boolean hasPrevious()</pre> +<div class="block">Returns true if this iterator has more elements when traversing in the reverse direction. It returns false if the iterator has been closed. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#hasPrevious()" title="class or interface in java.util"><CODE>ListIterator.hasPrevious()</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#hasPrevious()" title="class or interface in java.util">hasPrevious</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>whether <A HREF="../../../com/sleepycat/collections/StoredIterator.html#previous()"><CODE>previous()</CODE></A> will succeed. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="next()"><!-- --></A><H3> -next</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> <B>next</B>()</PRE> -<DL> -<DD>Returns the next element in the iteration. - This method conforms to the <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> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><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">next</A></CODE> in interface <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/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#next()" title="class or interface in java.util">next</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the next element. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="previous()"><!-- --></A><H3> -previous</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> <B>previous</B>()</PRE> -<DL> -<DD>Returns the next element in the iteration. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#previous()" title="class or interface in java.util"><CODE>ListIterator.previous()</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#previous()" title="class or interface in java.util">previous</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the previous element. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="nextIndex()"><!-- --></A><H3> -nextIndex</H3> -<PRE> -public int <B>nextIndex</B>()</PRE> -<DL> -<DD>Returns the index of the element that would be returned by a subsequent + This method conforms to the <code>ListIterator.hasPrevious()</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hasPrevious</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>whether <a href="../../../com/sleepycat/collections/StoredIterator.html#previous()"><code>previous()</code></a> will succeed.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C edition).</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> next()</pre> +<div class="block">Returns the next element in the iteration. + This method conforms to the <code>Iterator.next()</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>next</code> in interface <code>java.util.Iterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>next</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the next element.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="previous()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>previous</h4> +<pre>public <a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> previous()</pre> +<div class="block">Returns the next element in the iteration. + This method conforms to the <code>ListIterator.previous()</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>previous</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the previous element.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="nextIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextIndex</h4> +<pre>public int nextIndex()</pre> +<div class="block">Returns the index of the element that would be returned by a subsequent call to next. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#nextIndex()" title="class or interface in java.util"><CODE>ListIterator.nextIndex()</CODE></A> interface + This method conforms to the <code>ListIterator.nextIndex()</code> interface except that it returns Integer.MAX_VALUE for stored lists when positioned at the end of the list, rather than returning the list size as specified by the ListIterator interface. This is because the database - size is not available. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#nextIndex()" title="class or interface in java.util">nextIndex</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the next index. -<DT><B>Throws:</B> -<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 this iterator's collection does - not use record number keys. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="previousIndex()"><!-- --></A><H3> -previousIndex</H3> -<PRE> -public int <B>previousIndex</B>()</PRE> -<DL> -<DD>Returns the index of the element that would be returned by a subsequent + size is not available.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>nextIndex</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the next index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if this iterator's collection does + not use record number keys.</dd> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="previousIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>previousIndex</h4> +<pre>public int previousIndex()</pre> +<div class="block">Returns the index of the element that would be returned by a subsequent call to previous. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#previousIndex()" title="class or interface in java.util"><CODE>ListIterator.previousIndex()</CODE></A> - interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#previousIndex()" title="class or interface in java.util">previousIndex</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the previous index. -<DT><B>Throws:</B> -<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 this iterator's collection does - not use record number keys. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="set(java.lang.Object)"><!-- --></A><A NAME="set(E)"><!-- --></A><H3> -set</H3> -<PRE> -public void <B>set</B>(<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> value)</PRE> -<DL> -<DD>Replaces the last element returned by next or previous with the + This method conforms to the <code>ListIterator.previousIndex()</code> + interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>previousIndex</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the previous index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if this iterator's collection does + not use record number keys.</dd> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="set(java.lang.Object)"> +<!-- --> +</a><a name="set(E)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> value)</pre> +<div class="block">Replaces the last element returned by next or previous with the specified element (optional operation). - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#set(E)" title="class or interface in java.util"><CODE>ListIterator.set(E)</CODE></A> interface. + This method conforms to the <code>ListIterator.set(E)</code> interface. <p>In order to call this method, if the underlying Database is transactional then a transaction must be active when creating the - iterator.</p> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#set(E)" title="class or interface in java.util">set</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>value</CODE> - the new value. -<DT><B>Throws:</B> -<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 collection is a <A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><CODE>StoredKeySet</CODE></A> (the set returned by <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util"><CODE>Map.keySet()</CODE></A>), or if + iterator.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>set</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the new value.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is a <a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><code>StoredKeySet</code></a> (the set returned by <code>Map.keySet()</code>), or if duplicates are sorted since this would change the iterator position, or - if the collection is indexed, or if the collection is read-only. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an entity value binding is used and + if the collection is indexed, or if the collection is read-only.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an entity value binding is used and the primary key of the value given is different than the existing stored - primary key. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="remove()"><!-- --></A><H3> -remove</H3> -<PRE> -public void <B>remove</B>()</PRE> -<DL> -<DD>Removes the last element that was returned by next or previous (optional + primary key.</dd> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="remove()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public void remove()</pre> +<div class="block">Removes the last element that was returned by next or previous (optional operation). - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#remove()" title="class or interface in java.util"><CODE>ListIterator.remove()</CODE></A> interface except + This method conforms to the <code>ListIterator.remove()</code> interface except that when the collection is a list and the RECNO-RENUMBER access method is not used, list indices will not be renumbered. @@ -545,30 +489,31 @@ public void <B>remove</B>()</PRE> <p>Note that for the JE product, RECNO-RENUMBER databases are not supported, and therefore list indices are never renumbered by this - method.</p> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util">remove</A></CODE> in interface <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/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#remove()" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<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 collection is a sublist, or - if the collection is read-only. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="add(java.lang.Object)"><!-- --></A><A NAME="add(E)"><!-- --></A><H3> -add</H3> -<PRE> -public void <B>add</B>(<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A> value)</PRE> -<DL> -<DD>Inserts the specified element into the list or inserts a duplicate into + method.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>remove</code> in interface <code>java.util.Iterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>remove</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is a sublist, or + if the collection is read-only.</dd> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="add(java.lang.Object)"> +<!-- --> +</a><a name="add(E)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public void add(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a> value)</pre> +<div class="block">Inserts the specified element into the list or inserts a duplicate into other types of collections (optional operation). - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#add(E)" title="class or interface in java.util"><CODE>ListIterator.add(E)</CODE></A> interface when + This method conforms to the <code>ListIterator.add(E)</code> interface when the collection is a list and the RECNO-RENUMBER access method is used. Otherwise, this method may only be called when duplicates are allowed. If duplicates are unsorted, the new value will be inserted in the same @@ -577,153 +522,140 @@ public void <B>add</B>(<A HREF="../../../com/sleepycat/collections/StoredIterato <p>Note that for the JE product, RECNO-RENUMBER databases are not supported, and therefore this method may only be used to add - duplicates.</p> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true#add(E)" title="class or interface in java.util">add</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util">ListIterator</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>value</CODE> - the new value. -<DT><B>Throws:</B> -<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 collection is a sublist, or + duplicates.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>add</code> in interface <code>java.util.ListIterator<<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the new value.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is a sublist, or if the collection is indexed, or if the collection is read-only, or if the collection is a list and the RECNO-RENUMBER access method was not - used, or if the collection is not a list and duplicates are not allowed. -<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 collection is empty and is not a - list with RECNO-RENUMBER access. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if a duplicate value is being added - that already exists and duplicates are sorted. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="count()"><!-- --></A><H3> -count</H3> -<PRE> -public int <B>count</B>()</PRE> -<DL> -<DD>Returns the number of elements having the same key value as the key + used, or if the collection is not a list and duplicates are not allowed.</dd> +<dd><code>java.lang.IllegalStateException</code> - if the collection is empty and is not a + list with RECNO-RENUMBER access.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if a duplicate value is being added + that already exists and duplicates are sorted.</dd> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public int count()</pre> +<div class="block">Returns the number of elements having the same key value as the key value of the element last returned by next() or previous(). If no duplicates are allowed, 1 is always returned. - This method does not exist in the standard <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"><CODE>Iterator</CODE></A> or <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util"><CODE>ListIterator</CODE></A> interfaces. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the number of duplicates. -<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 next() or previous() has not been + This method does not exist in the standard <code>Iterator</code> or <code>ListIterator</code> interfaces.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of duplicates.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if next() or previous() has not been called for this iterator, or if remove() or add() were called after - the last call to next() or previous().</DL> -</DD> -</DL> -<HR> - -<A NAME="close()"><!-- --></A><H3> -close</H3> -<PRE> -public void <B>close</B>()</PRE> -<DL> -<DD>Closes this iterator. - This method does not exist in the standard <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"><CODE>Iterator</CODE></A> or <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util"><CODE>ListIterator</CODE></A> interfaces. - - <p>After being closed, only the <A HREF="../../../com/sleepycat/collections/StoredIterator.html#hasNext()"><CODE>hasNext()</CODE></A> and <A HREF="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious()"><CODE>hasPrevious()</CODE></A> methods may be called and these will return false. <A HREF="../../../com/sleepycat/collections/StoredIterator.html#close()"><CODE>close()</CODE></A> may also be called again and will do nothing. If other + the last call to next() or previous().</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Closes this iterator. + This method does not exist in the standard <code>Iterator</code> or <code>ListIterator</code> interfaces. + + <p>After being closed, only the <a href="../../../com/sleepycat/collections/StoredIterator.html#hasNext()"><code>hasNext()</code></a> and <a href="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious()"><code>hasPrevious()</code></a> methods may be called and these will return false. <a href="../../../com/sleepycat/collections/StoredIterator.html#close()"><code>close()</code></a> may also be called again and will do nothing. If other methods are called a <code>NullPointerException</code> will generally be - thrown.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="getCollection()"><!-- --></A><H3> -getCollection</H3> -<PRE> -public final <A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A><<A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</A>> <B>getCollection</B>()</PRE> -<DL> -<DD>Returns the collection associated with this iterator. - This method does not exist in the standard <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"><CODE>Iterator</CODE></A> or <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util"><CODE>ListIterator</CODE></A> interfaces. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the collection associated with this iterator.</DL> -</DD> -</DL> + thrown.</p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="getCollection()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCollection</h4> +<pre>public final <a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a><<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>> getCollection()</pre> +<div class="block">Returns the collection associated with this iterator. + This method does not exist in the standard <code>Iterator</code> or <code>ListIterator</code> interfaces.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the collection associated with this iterator.</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/StoredIterator.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/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/collections/StoredIterator.html" target="_top"><B>FRAMES</B></A> - <A HREF="StoredIterator.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/StoredIterator.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/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/collections/StoredIterator.html" target="_top">Frames</a></li> +<li><a href="StoredIterator.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> |