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/StoredCollection.html
Greg Burd 10c9f34f67 Initial import.
2021-06-06 13:46:45 -04:00

948 lines
52 KiB
HTML
Raw Permalink 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>StoredCollection (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="StoredCollection (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":42,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/StoredCollection.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/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollections.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/StoredCollection.html" target="_top">Frames</a></li>
<li><a href="StoredCollection.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 StoredCollection" class="title">Class StoredCollection&lt;E&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredContainer</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.StoredCollection&lt;E&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable, java.lang.Iterable&lt;E&gt;, java.util.Collection&lt;E&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections">StoredEntrySet</a>, <a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections">StoredKeySet</a>, <a href="../../../com/sleepycat/collections/StoredValueSet.html" title="class in com.sleepycat.collections">StoredValueSet</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">StoredCollection&lt;E&gt;</span>
extends <a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>
implements java.util.Collection&lt;E&gt;</pre>
<div class="block">A abstract base class for all stored collections. This class, and its
base class <a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections"><code>StoredContainer</code></a>, provide implementations of most methods
in the <code>Collection</code> interface. Other methods, such as <a href="../../../com/sleepycat/collections/StoredCollection.html#add-java.lang.Object-java.lang.Object-"><code>add(java.lang.Object, java.lang.Object)</code></a>
and <code>Collection.remove(java.lang.Object)</code>, are provided by concrete classes that extend this
class.
<p>In addition, this class provides the following methods for stored
collections 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/StoredCollection.html#getIteratorBlockSize--"><code>getIteratorBlockSize()</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize-int-"><code>setIteratorBlockSize(int)</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator--"><code>storedIterator()</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator-boolean-"><code>storedIterator(boolean)</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollection.html#join-com.sleepycat.collections.StoredContainer:A-java.lang.Object:A-com.sleepycat.je.JoinConfig-"><code>join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.je.JoinConfig)</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollection.html#toList--"><code>toList()</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</a></span></code>
<div class="block">The default number of records read at one time by iterators.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#addAll-java.util.Collection-">addAll</a></span>(java.util.Collection&lt;? extends <a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;coll)</code>
<div class="block">Adds all of the elements in the specified collection to this collection
(optional operation).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#containsAll-java.util.Collection-">containsAll</a></span>(java.util.Collection&lt;?&gt;&nbsp;coll)</code>
<div class="block">Returns true if this collection contains all of the elements in the
specified collection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;other)</code>
<div class="block">Compares the specified object with this collection for equality.</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/StoredCollection.html#getIteratorBlockSize--">getIteratorBlockSize</a></span>()</code>
<div class="block">Returns the number of records read at one time by iterators returned by
the <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator--"><code>iterator()</code></a> method.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns an iterator over the elements in this collection.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#iterator-boolean-">iterator</a></span>(boolean&nbsp;writeAllowed)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Please use <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator--"><code>storedIterator()</code></a> or <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator-boolean-"><code>storedIterator(boolean)</code></a> instead. Because the iterator returned must
be closed, the method name <code>iterator</code> is confusing since standard
Java iterators do not need to be closed.</span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#join-com.sleepycat.collections.StoredContainer:A-java.lang.Object:A-com.sleepycat.je.JoinConfig-">join</a></span>(<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>[]&nbsp;indices,
java.lang.Object[]&nbsp;indexKeys,
<a href="../../../com/sleepycat/je/JoinConfig.html" title="class in com.sleepycat.je">JoinConfig</a>&nbsp;joinConfig)</code>
<div class="block">Returns an iterator representing an equality join of the indices and
index key values specified.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#removeAll-java.util.Collection-">removeAll</a></span>(java.util.Collection&lt;?&gt;&nbsp;coll)</code>
<div class="block">Removes all this collection's elements that are also contained in the
specified collection (optional operation).</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#retainAll-java.util.Collection-">retainAll</a></span>(java.util.Collection&lt;?&gt;&nbsp;coll)</code>
<div class="block">Retains only the elements in this collection that are contained in the
specified collection (optional operation).</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize-int-">setIteratorBlockSize</a></span>(int&nbsp;blockSize)</code>
<div class="block">Changes the number of records read at one time by iterators returned by
the <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator--"><code>iterator()</code></a> method.</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/StoredCollection.html#size--">size</a></span>()</code>
<div class="block">Returns a non-transactional count of the records in the collection or
map.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator--">storedIterator</a></span>()</code>
<div class="block">Returns an iterator over the elements in this collection.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator-boolean-">storedIterator</a></span>(boolean&nbsp;writeAllowed)</code>
<div class="block">Returns a read or read-write iterator over the elements in this
collection.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.Object[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#toArray--">toArray</a></span>()</code>
<div class="block">Returns an array of all the elements in this collection.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#toArray-T:A-">toArray</a></span>(T[]&nbsp;a)</code>
<div class="block">Returns an array of all the elements in this collection whose runtime
type is that of the specified array.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#toList--">toList</a></span>()</code>
<div class="block">Returns a copy of this collection as an ArrayList.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredCollection.html#toString--">toString</a></span>()</code>
<div class="block">Converts the collection to a string representation for debugging.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.collections.StoredContainer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.sleepycat.collections.<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a></h3>
<code><a href="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed--">areDuplicatesAllowed</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered--">areDuplicatesOrdered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed--">areKeyRangesAllowed</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered--">areKeysRenumbered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#clear--">clear</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig--">getCursorConfig</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isEmpty--">isEmpty</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isOrdered--">isOrdered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isSecondary--">isSecondary</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isTransactional--">isTransactional</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed--">isWriteAllowed</a></code></li>
</ul>
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Collection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Collection</h3>
<code>add, clear, contains, isEmpty, parallelStream, remove, removeIf, spliterator, stream</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.Iterable</h3>
<code>forEach</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_ITERATOR_BLOCK_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_ITERATOR_BLOCK_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_ITERATOR_BLOCK_SIZE</pre>
<div class="block">The default number of records read at one time by iterators.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize-int-"><code>setIteratorBlockSize(int)</code></a>,
<a href="../../../constant-values.html#com.sleepycat.collections.StoredCollection.DEFAULT_ITERATOR_BLOCK_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getIteratorBlockSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIteratorBlockSize</h4>
<pre>public&nbsp;int&nbsp;getIteratorBlockSize()</pre>
<div class="block">Returns the number of records read at one time by iterators returned by
the <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator--"><code>iterator()</code></a> method. By default this value is <a href="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE"><code>DEFAULT_ITERATOR_BLOCK_SIZE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of records.</dd>
</dl>
</li>
</ul>
<a name="setIteratorBlockSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIteratorBlockSize</h4>
<pre>public&nbsp;void&nbsp;setIteratorBlockSize(int&nbsp;blockSize)</pre>
<div class="block">Changes the number of records read at one time by iterators returned by
the <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator--"><code>iterator()</code></a> method. By default this value is <a href="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE"><code>DEFAULT_ITERATOR_BLOCK_SIZE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>blockSize</code> - the number of records.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the blockSize is less than two.</dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;iterator()</pre>
<div class="block">Returns an iterator over the elements in this collection.
The iterator will be read-only if the collection is read-only.
This method conforms to the <code>Collection.iterator()</code> interface.
<p>The iterator returned by this method does not keep a database cursor
open and therefore it does not need to be closed. It reads blocks of
records as needed, opening and closing a cursor to read each block of
records. The number of records per block is 10 by default and can be
changed with <a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize-int-"><code>setIteratorBlockSize(int)</code></a>.</p>
<p>Because this iterator does not keep a cursor open, if it is used
without transactions, the iterator does not have <em>cursor
stability</em> characteristics. In other words, the record at the
current iterator position can be changed or deleted by another thread.
To prevent this from happening, call this method within a transaction or
use the <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator--"><code>storedIterator()</code></a> method instead.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a standard <code>Iterator</code> for this collection.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed--"><code>StoredContainer.isWriteAllowed()</code></a></dd>
</dl>
</li>
</ul>
<a name="storedIterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storedIterator</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;storedIterator()</pre>
<div class="block">Returns an iterator over the elements in this collection.
The iterator will be read-only if the collection is read-only.
This method does not exist in the standard <code>Collection</code> interface.
<p>If <code>Iterator.set</code> or <code>Iterator.remove</code> will be called
and the underlying Database is transactional, then a transaction must be
active when calling this method and must remain active while using the
iterator.</p>
<p><strong>Warning:</strong> The iterator returned must be explicitly
closed using <a href="../../../com/sleepycat/collections/StoredIterator.html#close--"><code>StoredIterator.close()</code></a> or <a href="../../../com/sleepycat/collections/StoredIterator.html#close-java.util.Iterator-"><code>StoredIterator.close(java.util.Iterator)</code></a> to release the underlying
database cursor resources.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a> for this collection.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed--"><code>StoredContainer.isWriteAllowed()</code></a></dd>
</dl>
</li>
</ul>
<a name="storedIterator-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storedIterator</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;storedIterator(boolean&nbsp;writeAllowed)</pre>
<div class="block">Returns a read or read-write iterator over the elements in this
collection.
This method does not exist in the standard <code>Collection</code> interface.
<p>If <code>Iterator.set</code> or <code>Iterator.remove</code> will be called
and the underlying Database is transactional, then a transaction must be
active when calling this method and must remain active while using the
iterator.</p>
<p><strong>Warning:</strong> The iterator returned must be explicitly
closed using <a href="../../../com/sleepycat/collections/StoredIterator.html#close--"><code>StoredIterator.close()</code></a> or <a href="../../../com/sleepycat/collections/StoredIterator.html#close-java.util.Iterator-"><code>StoredIterator.close(java.util.Iterator)</code></a> to release the underlying
database cursor resources.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writeAllowed</code> - is true to open a read-write iterator or false to
open a read-only iterator. If the collection is read-only the iterator
will always be read-only.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a> for this collection.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if writeAllowed is true but 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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed--"><code>StoredContainer.isWriteAllowed()</code></a></dd>
</dl>
</li>
</ul>
<a name="iterator-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;iterator(boolean&nbsp;writeAllowed)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Please use <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator--"><code>storedIterator()</code></a> or <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator-boolean-"><code>storedIterator(boolean)</code></a> instead. Because the iterator returned must
be closed, the method name <code>iterator</code> is confusing since standard
Java iterators do not need to be closed.</span></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writeAllowed</code> - is true to open a read-write iterator or false to
open a read-only iterator. If the collection is read-only the iterator
will always be read-only.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><code>StoredIterator</code></a> for this collection.</dd>
</dl>
</li>
</ul>
<a name="toArray--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public&nbsp;java.lang.Object[]&nbsp;toArray()</pre>
<div class="block">Returns an array of all the elements in this collection.
This method conforms to the <code>Collection.toArray()</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>toArray</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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#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="toArray-java.lang.Object:A-">
<!-- -->
</a><a name="toArray-T:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T[]&nbsp;toArray(T[]&nbsp;a)</pre>
<div class="block">Returns an array of all the elements in this collection whose runtime
type is that of the specified array.
This method conforms to the <code>Collection.toArray(Object[])</code>
interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>toArray</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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#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="containsAll-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsAll</h4>
<pre>public&nbsp;boolean&nbsp;containsAll(java.util.Collection&lt;?&gt;&nbsp;coll)</pre>
<div class="block">Returns true if this collection contains all of the elements in the
specified collection.
This method conforms to the <code>Collection.containsAll(java.util.Collection&lt;?&gt;)</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>containsAll</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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#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="addAll-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre>public&nbsp;boolean&nbsp;addAll(java.util.Collection&lt;? extends <a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;coll)</pre>
<div class="block">Adds all of the elements in the specified collection to this collection
(optional operation).
This method calls the <code>Collection.add(Object)</code> method of the concrete
collection class, which may or may not be supported.
This method conforms to the <code>Collection.addAll(java.util.Collection&lt;? extends E&gt;)</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>addAll</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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 read-only, or
if the collection is indexed, or if the add method is not supported by
the concrete collection.</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="removeAll-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>public&nbsp;boolean&nbsp;removeAll(java.util.Collection&lt;?&gt;&nbsp;coll)</pre>
<div class="block">Removes all this collection's elements that are also contained in the
specified collection (optional operation).
This method conforms to the <code>Collection.removeAll(java.util.Collection&lt;?&gt;)</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>removeAll</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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 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="retainAll-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retainAll</h4>
<pre>public&nbsp;boolean&nbsp;retainAll(java.util.Collection&lt;?&gt;&nbsp;coll)</pre>
<div class="block">Retains only the elements in this collection that are contained in the
specified collection (optional operation).
This method conforms to the <code>Collection.removeAll(java.util.Collection&lt;?&gt;)</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>retainAll</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">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 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="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;other)</pre>
<div class="block">Compares the specified object with this collection for equality.
A value comparison is performed by this method and the stored values
are compared rather than calling the equals() method of each element.
This method conforms to the <code>Collection.equals(java.lang.Object)</code> interface.
<!-- begin JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>equals</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</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#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="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hashCode</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toList</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;toList()</pre>
<div class="block">Returns a copy of this collection as an ArrayList. This is the same as
<a href="../../../com/sleepycat/collections/StoredCollection.html#toArray--"><code>toArray()</code></a> but returns a collection instead of an array.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>ArrayList</code> containing a copy of all elements in this
collection.
<!-- 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="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Converts the collection to a string representation for debugging.
WARNING: The returned string may be very large.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string representation.
<!-- 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="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../com/sleepycat/collections/StoredContainer.html#size--">StoredContainer</a></code></span></div>
<div class="block">Returns a non-transactional count of the records in the collection or
map. This method conforms to the <code>Collection.size()</code> and
<code>Map.size()</code> interfaces.
<!-- begin JE only -->
<p>This operation is faster than obtaining a count by scanning the
collection manually, and will not perturb the current contents of the
cache. However, the count is not guaranteed to be accurate if there are
concurrent updates.</p>
<!-- end JE only --></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>size</code>&nbsp;in interface&nbsp;<code>java.util.Collection&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/sleepycat/collections/StoredContainer.html#size--">size</a></code>&nbsp;in class&nbsp;<code><a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of records.
<!-- begin JE only --></dd>
</dl>
</li>
</ul>
<a name="join-com.sleepycat.collections.StoredContainer:A-java.lang.Object:A-com.sleepycat.je.JoinConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>join</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a>&lt;<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>&gt;&nbsp;join(<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>[]&nbsp;indices,
java.lang.Object[]&nbsp;indexKeys,
<a href="../../../com/sleepycat/je/JoinConfig.html" title="class in com.sleepycat.je">JoinConfig</a>&nbsp;joinConfig)</pre>
<div class="block">Returns an iterator representing an equality join of the indices and
index key values specified.
This method does not exist in the standard <code>Collection</code> interface.
<p><strong>Warning:</strong> The iterator returned must be explicitly
closed using <a href="../../../com/sleepycat/collections/StoredIterator.html#close--"><code>StoredIterator.close()</code></a> or <a href="../../../com/sleepycat/collections/StoredIterator.html#close-java.util.Iterator-"><code>StoredIterator.close(java.util.Iterator)</code></a> to release the underlying
database cursor resources.</p>
<p>The returned iterator supports only the two methods: hasNext() and
next(). All other methods will throw UnsupportedOperationException.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indices</code> - is an array of indices with elements corresponding to
those in the indexKeys array.</dd>
<dd><code>indexKeys</code> - is an array of index key values identifying the
elements to be selected.</dd>
<dd><code>joinConfig</code> - is the join configuration, or null to use the
default configuration.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over the elements in this collection that match
all specified index key values.
<!-- 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.IllegalArgumentException</code> - if this collection is indexed or if a
given index does not have the same store as this collection.</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>
</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/StoredCollection.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/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredCollections.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/StoredCollection.html" target="_top">Frames</a></li>
<li><a href="StoredCollection.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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