greg/je
1
0
Fork 0
mirror of https://github.com/berkeleydb/je.git synced 2024-11-15 01:46:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
je/docs/java/com/sleepycat/collections/StoredIterator.html
Greg Burd 10c9f34f67 Initial import.
2021-06-06 13:46:45 -04:00

807 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:44 EDT 2017 -->
<title>StoredIterator (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StoredIterator (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.collections</div>
<h2 title="Class StoredIterator" class="title">Class StoredIterator&lt;E&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.StoredIterator&lt;E&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable, java.lang.Cloneable, java.util.Iterator&lt;E&gt;, java.util.ListIterator&lt;E&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StoredIterator&lt;E&gt;</span>
extends java.lang.Object
implements java.util.ListIterator&lt;E&gt;, java.lang.Cloneable, java.io.Closeable</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
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 <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>
<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></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Hayes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#add-E-">add</a></span>(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;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 id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#close--">close</a></span>()</code>
<div class="block">Closes this iterator.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#close-java.util.Iterator-">close</a></span>(java.util.Iterator&lt;?&gt;&nbsp;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 id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#count--">count</a></span>()</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 id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a>&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#getCollection--">getCollection</a></span>()</code>
<div class="block">Returns the collection associated with this iterator.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#hasNext--">hasNext</a></span>()</code>
<div class="block">Returns true if this iterator has more elements when traversing in the
forward direction.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#hasPrevious--">hasPrevious</a></span>()</code>
<div class="block">Returns true if this iterator has more elements when traversing in the
reverse direction.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#isReadModifyWrite--">isReadModifyWrite</a></span>()</code>
<div class="block">Returns whether write-locks will be obtained when reading with this
cursor.</div>
</td>
</tr>
<tr id="i8" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#next--">next</a></span>()</code>
<div class="block">Returns the next element in the iteration.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#nextIndex--">nextIndex</a></span>()</code>
<div class="block">Returns the index of the element that would be returned by a subsequent
call to next.</div>
</td>
</tr>
<tr id="i10" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#previous--">previous</a></span>()</code>
<div class="block">Returns the next element in the iteration.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#previousIndex--">previousIndex</a></span>()</code>
<div class="block">Returns the index of the element that would be returned by a subsequent
call to previous.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#remove--">remove</a></span>()</code>
<div class="block">Removes the last element that was returned by next or previous (optional
operation).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#set-E-">set</a></span>(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;value)</code>
<div class="block">Replaces the last element returned by next or previous with the
specified element (optional operation).</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredIterator.html#setReadModifyWrite-boolean-">setReadModifyWrite</a></span>(boolean&nbsp;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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Iterator</h3>
<code>forEachRemaining</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close-java.util.Iterator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public static&nbsp;void&nbsp;close(java.util.Iterator&lt;?&gt;&nbsp;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="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - is the iterator to close.</dd>
<dt><span class="throwsLabel">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&nbsp;boolean&nbsp;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.</div>
<dl>
<dt><span class="returnLabel">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&nbsp;void&nbsp;setReadModifyWrite(boolean&nbsp;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.</div>
<dl>
<dt><span class="paramLabel">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&nbsp;boolean&nbsp;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 <code>Iterator.hasNext()</code> interface.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hasNext</code>&nbsp;in interface&nbsp;<code>java.util.Iterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hasNext</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether <a href="../../../com/sleepycat/collections/StoredIterator.html#next--"><code>next()</code></a> will succeed.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE 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="hasPrevious--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPrevious</h4>
<pre>public&nbsp;boolean&nbsp;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 <code>ListIterator.hasPrevious()</code> interface.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hasPrevious</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether <a href="../../../com/sleepycat/collections/StoredIterator.html#previous--"><code>previous()</code></a> will succeed.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE 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="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>next</code>&nbsp;in interface&nbsp;<code>java.util.Iterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>next</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next element.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE 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="previous--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>previous</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>previous</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous element.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE 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="nextIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextIndex</h4>
<pre>public&nbsp;int&nbsp;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 <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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>nextIndex</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next index.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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&nbsp;int&nbsp;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 <code>ListIterator.previousIndex()</code>
interface.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>previousIndex</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous index.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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&nbsp;void&nbsp;set(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;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 <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></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>set</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the new value.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#writeFailures">Write
Operation Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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>
<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>
<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&nbsp;void&nbsp;remove()</pre>
<div class="block">Removes the last element that was returned by next or previous (optional
operation).
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.
<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>Note that for the JE product, RECNO-RENUMBER databases are not
supported, and therefore list indices are never renumbered by this
method.</p>
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>remove</code>&nbsp;in interface&nbsp;<code>java.util.Iterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>remove</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#writeFailures">Write
Operation Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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&nbsp;void&nbsp;add(<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&nbsp;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 <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
manner as list elements.
If duplicates are sorted, the new value will be inserted in sort order.
<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></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>add</code>&nbsp;in interface&nbsp;<code>java.util.ListIterator&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the new value.
<!-- begin JE only --></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#writeFailures">Write
Operation Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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>
<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&nbsp;int&nbsp;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 <code>Iterator</code> or <code>ListIterator</code> interfaces.
<!-- begin JE only --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of duplicates.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
href="../je/OperationFailureException.html#readFailures">Read Operation
Failures</a> occurs.</dd>
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
environment-wide failure occurs.
<!-- end JE only --></dd>
<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().</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;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></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="throwsLabel">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&nbsp;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a>&lt;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="type parameter in StoredIterator">E</a>&gt;&nbsp;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="returnLabel">Returns:</span></dt>
<dd>the collection associated with this iterator.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>
Reference in a new issue View git blame Copy permalink