diff options
Diffstat (limited to 'docs/java/com/sleepycat/collections/StoredCollection.html')
| -rw-r--r-- | docs/java/com/sleepycat/collections/StoredCollection.html | 1499 |
1 files changed, 705 insertions, 794 deletions
diff --git a/docs/java/com/sleepycat/collections/StoredCollection.html b/docs/java/com/sleepycat/collections/StoredCollection.html index 21055b15..6167d388 100644 --- a/docs/java/com/sleepycat/collections/StoredCollection.html +++ b/docs/java/com/sleepycat/collections/StoredCollection.html @@ -1,466 +1,417 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:06 EDT 2012 --> -<TITLE> -StoredCollection (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:54 EST 2015 --> +<title>StoredCollection (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="StoredCollection (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/collections/StoredCollection.html" target="_top"><B>FRAMES</B></A> - <A HREF="StoredCollection.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/collections/StoredCollection.html" target="_top">Frames</a></li> +<li><a href="StoredCollection.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> <!-- ========= END OF TOP NAVBAR ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.collections</FONT> -<BR> -Class StoredCollection<E></H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredContainer</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.collections.StoredCollection<E></B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><E>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><E></DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <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/StoredList.html" title="class in com.sleepycat.collections">StoredList</A>, <A HREF="../../../com/sleepycat/collections/StoredValueSet.html" title="class in com.sleepycat.collections">StoredValueSet</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public abstract class <B>StoredCollection<E></B><DT>extends <A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A><DT>implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><E></DL> -</PRE> - -<P> -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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.remove(java.lang.Object)</CODE></A>, are provided by concrete classes that extend this +<div class="header"> +<div class="subTitle">com.sleepycat.collections</div> +<h2 title="Class StoredCollection" class="title">Class StoredCollection<E></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<E></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<E>, java.util.Collection<E></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/StoredList.html" title="class in com.sleepycat.collections">StoredList</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="strong">StoredCollection<E></span> +extends <a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a> +implements java.util.Collection<E></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,%20java.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[], java.lang.Object[], com.sleepycat.db.JoinConfig)"><CODE>join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)</CODE></A></li> - <li><A HREF="../../../com/sleepycat/collections/StoredCollection.html#toList()"><CODE>toList()</CODE></A></li> - </ul> -<P> - -<P> -<HR> - -<P> + <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[],%20java.lang.Object[],%20com.sleepycat.db.JoinConfig)"><code>join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)</code></a></li> + <li><a href="../../../com/sleepycat/collections/StoredCollection.html#toList()"><code>toList()</code></a></li> + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> - -<A NAME="field_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Field Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</A></B></CODE> - -<BR> - The default number of records read at one time by iterators.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </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><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</a></strong></code> +<div class="block">The default number of records read at one time by iterators.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)">addAll</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><? extends <A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> coll)</CODE> - -<BR> - Adds all of the elements in the specified collection to this collection - (optional operation).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#containsAll(java.util.Collection)">containsAll</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</CODE> - -<BR> - Returns true if this collection contains all of the elements in the - specified collection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE> - -<BR> - Compares the specified object with this collection for equality.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()">getIteratorBlockSize</A></B>()</CODE> - -<BR> - 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.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#hashCode()">hashCode</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#iterator()">iterator</A></B>()</CODE> - -<BR> - Returns an iterator over the elements in this collection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#iterator(boolean)">iterator</A></B>(boolean writeAllowed)</CODE> - -<BR> - <B>Deprecated.</B> <I>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 +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)">addAll</a></strong>(java.util.Collection<? extends <a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> coll)</code> +<div class="block">Adds all of the elements in the specified collection to this collection + (optional operation).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#containsAll(java.util.Collection)">containsAll</a></strong>(java.util.Collection<?> coll)</code> +<div class="block">Returns true if this collection contains all of the elements in the + specified collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> +<div class="block">Compares the specified object with this collection for equality.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()">getIteratorBlockSize</a></strong>()</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 class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#iterator()">iterator</a></strong>()</code> +<div class="block">Returns an iterator over the elements in this collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#iterator(boolean)">iterator</a></strong>(boolean writeAllowed)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>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.</I></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)">join</A></B>(<A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A>[] indices, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] indexKeys, - <A HREF="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A> joinConfig)</CODE> - -<BR> - Returns an iterator representing an equality join of the indices and - index key values specified.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</CODE> - -<BR> - Removes all this collection's elements that are also contained in the - specified collection (optional operation).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#retainAll(java.util.Collection)">retainAll</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</CODE> - -<BR> - Retains only the elements in this collection that are contained in the - specified collection (optional operation).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)">setIteratorBlockSize</A></B>(int blockSize)</CODE> - -<BR> - 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.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#size()">size</A></B>()</CODE> - -<BR> - Returns a non-transactional count of the records in the collection or - map.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#storedIterator()">storedIterator</A></B>()</CODE> - -<BR> - Returns an iterator over the elements in this collection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)">storedIterator</A></B>(boolean writeAllowed)</CODE> - -<BR> - Returns a read or read-write iterator over the elements in this - collection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#toArray()">toArray</A></B>()</CODE> - -<BR> - Returns an array of all the elements in this collection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> -<TR ALIGN="right" VALIGN=""> -<TD NOWRAP><FONT SIZE="-1"> -<CODE><T> T[]</CODE></FONT></TD> -</TR> -</TABLE> -</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#toArray(T[])">toArray</A></B>(T[] a)</CODE> - -<BR> - Returns an array of all the elements in this collection whose runtime - type is that of the specified array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#toList()">toList</A></B>()</CODE> - -<BR> - Returns a copy of this collection as an ArrayList.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredCollection.html#toString()">toString</A></B>()</CODE> - -<BR> - Converts the collection to a string representation for debugging.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_com.sleepycat.collections.StoredContainer"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.collections.<A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><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></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.util.Collection"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util">add</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#contains(java.lang.Object)" title="class or interface in java.util">contains</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE></TD> -</TR> -</TABLE> - -<P> - + Java iterators do not need to be closed.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#join(com.sleepycat.collections.StoredContainer[],%20java.lang.Object[],%20com.sleepycat.db.JoinConfig)">join</a></strong>(<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>[] indices, + java.lang.Object[] indexKeys, + <a href="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</a> joinConfig)</code> +<div class="block">Returns an iterator representing an equality join of the indices and + index key values specified.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#removeAll(java.util.Collection)">removeAll</a></strong>(java.util.Collection<?> 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 class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#retainAll(java.util.Collection)">retainAll</a></strong>(java.util.Collection<?> 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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)">setIteratorBlockSize</a></strong>(int 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 class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#size()">size</a></strong>()</code> +<div class="block">Returns a non-transactional count of the records in the collection or + map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator()">storedIterator</a></strong>()</code> +<div class="block">Returns an iterator over the elements in this collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)">storedIterator</a></strong>(boolean writeAllowed)</code> +<div class="block">Returns a read or read-write iterator over the elements in this + collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#toArray()">toArray</a></strong>()</code> +<div class="block">Returns an array of all the elements in this collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T> T[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#toArray(T[])">toArray</a></strong>(T[] 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 class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#toList()">toList</a></strong>()</code> +<div class="block">Returns a copy of this collection as an ArrayList.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredCollection.html#toString()">toString</a></strong>()</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 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 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 java.util.Collection</h3> +<code>add, clear, contains, isEmpty, remove</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ FIELD DETAIL =========== --> - -<A NAME="field_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="DEFAULT_ITERATOR_BLOCK_SIZE"><!-- --></A><H3> -DEFAULT_ITERATOR_BLOCK_SIZE</H3> -<PRE> -public static final int <B>DEFAULT_ITERATOR_BLOCK_SIZE</B></PRE> -<DL> -<DD>The default number of records read at one time by iterators. -<P> -<DL> -<DT><B>See Also:</B><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></DL> -</DL> - +<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 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="strong">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 ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="getIteratorBlockSize()"><!-- --></A><H3> -getIteratorBlockSize</H3> -<PRE> -public int <B>getIteratorBlockSize</B>()</PRE> -<DL> -<DD>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>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setIteratorBlockSize(int)"><!-- --></A><H3> -setIteratorBlockSize</H3> -<PRE> -public void <B>setIteratorBlockSize</B>(int blockSize)</PRE> -<DL> -<DD>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>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the blockSize is less than two.</DL> -</DD> -</DL> -<HR> - -<A NAME="iterator()"><!-- --></A><H3> -iterator</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>iterator</B>()</PRE> -<DL> -<DD>Returns an iterator over the elements in this collection. +<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 int 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> +</li> +</ul> +<a name="setIteratorBlockSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIteratorBlockSize</h4> +<pre>public void setIteratorBlockSize(int 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="strong">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 java.util.Iterator<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#iterator()" title="class or interface in java.util"><CODE>Collection.iterator()</CODE></A> interface. + 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> + 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> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#iterator()" title="class or interface in java.util">iterator</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>a standard <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><CODE>Iterator</CODE></A> for this collection.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="storedIterator()"><!-- --></A><H3> -storedIterator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>storedIterator</B>()</PRE> -<DL> -<DD>Returns an iterator over the elements in this collection. + use the <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator()"><code>storedIterator()</code></a> method instead.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a standard <code>Iterator</code> for this collection.</dd><dt><span class="strong">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 <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. + 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 @@ -468,27 +419,21 @@ public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="c 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>a <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><CODE>StoredIterator</CODE></A> for this collection.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="storedIterator(boolean)"><!-- --></A><H3> -storedIterator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>storedIterator</B>(boolean writeAllowed)</PRE> -<DL> -<DD>Returns a read or read-write iterator over the elements in this + 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="strong">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="strong">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 <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> storedIterator(boolean 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. + 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 @@ -496,371 +441,337 @@ public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="c 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>writeAllowed</CODE> - is true to open a read-write iterator or false to + 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="strong">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. -<DT><B>Returns:</B><DD>a <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections"><CODE>StoredIterator</CODE></A> for this collection. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if writeAllowed is true but the collection - is read-only. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="iterator(boolean)"><!-- --></A><H3> -iterator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>iterator</B>(boolean writeAllowed)</PRE> -<DL> -<DD><B>Deprecated.</B> <I>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 + will always be read-only.</dd> +<dt><span class="strong">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="strong">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="strong">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 <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> iterator(boolean writeAllowed)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>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.</I> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="toArray()"><!-- --></A><H3> -toArray</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] <B>toArray</B>()</PRE> -<DL> -<DD>Returns an array of all the elements in this collection. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#toArray()" title="class or interface in java.util"><CODE>Collection.toArray()</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#toArray()" title="class or interface in java.util">toArray</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="toArray(java.lang.Object[])"><!-- --></A><A NAME="toArray(T[])"><!-- --></A><H3> -toArray</H3> -<PRE> -public <T> T[] <B>toArray</B>(T[] a)</PRE> -<DL> -<DD>Returns an array of all the elements in this collection whose runtime + Java iterators do not need to be closed.</i></div> +</li> +</ul> +<a name="toArray()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toArray</h4> +<pre>public java.lang.Object[] 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.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>toArray</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="toArray(java.lang.Object[])"> +<!-- --> +</a><a name="toArray(T[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toArray</h4> +<pre>public <T> T[] toArray(T[] 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#toArray(T[])" title="class or interface in java.util"><CODE>Collection.toArray(Object[])</CODE></A> - interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#toArray(T[])" title="class or interface in java.util">toArray</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="containsAll(java.util.Collection)"><!-- --></A><H3> -containsAll</H3> -<PRE> -public boolean <B>containsAll</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</PRE> -<DL> -<DD>Returns true if this collection contains all of the elements in the + This method conforms to the <code>Collection.toArray(Object[])</code> + interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>toArray</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="containsAll(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsAll</h4> +<pre>public boolean containsAll(java.util.Collection<?> coll)</pre> +<div class="block">Returns true if this collection contains all of the elements in the specified collection. - This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.containsAll(java.util.Collection<?>)</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="addAll(java.util.Collection)"><!-- --></A><H3> -addAll</H3> -<PRE> -public boolean <B>addAll</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><? extends <A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> coll)</PRE> -<DL> -<DD>Adds all of the elements in the specified collection to this collection + This method conforms to the <code>Collection.containsAll(java.util.Collection<?>)</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>containsAll</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="addAll(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAll</h4> +<pre>public boolean addAll(java.util.Collection<? extends <a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> coll)</pre> +<div class="block">Adds all of the elements in the specified collection to this collection (optional operation). - This method calls the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util"><CODE>Collection.add(Object)</CODE></A> method of the concrete + 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#addAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.addAll(java.util.Collection<? extends E>)</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only, or + This method conforms to the <code>Collection.addAll(java.util.Collection<? extends E>)</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>addAll</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<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><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="removeAll(java.util.Collection)"><!-- --></A><H3> -removeAll</H3> -<PRE> -public boolean <B>removeAll</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</PRE> -<DL> -<DD>Removes all this collection's elements that are also contained in the + 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 boolean removeAll(java.util.Collection<?> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.removeAll(java.util.Collection<?>)</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="retainAll(java.util.Collection)"><!-- --></A><H3> -retainAll</H3> -<PRE> -public boolean <B>retainAll</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> coll)</PRE> -<DL> -<DD>Retains only the elements in this collection that are contained in the + This method conforms to the <code>Collection.removeAll(java.util.Collection<?>)</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>removeAll</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<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 boolean retainAll(java.util.Collection<?> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.removeAll(java.util.Collection<?>)</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="equals(java.lang.Object)"><!-- --></A><H3> -equals</H3> -<PRE> -public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE> -<DL> -<DD>Compares the specified object with this collection for equality. + This method conforms to the <code>Collection.removeAll(java.util.Collection<?>)</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>retainAll</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<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 boolean equals(java.lang.Object 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.equals(java.lang.Object)</CODE></A> interface. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="hashCode()"><!-- --></A><H3> -hashCode</H3> -<PRE> -public int <B>hashCode</B>()</PRE> -<DL> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#hashCode()" title="class or interface in java.util">hashCode</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="toList()"><!-- --></A><H3> -toList</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>toList</B>()</PRE> -<DL> -<DD>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. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>an <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util"><CODE>ArrayList</CODE></A> containing a copy of all elements in this - collection. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="toString()"><!-- --></A><H3> -toString</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> -<DL> -<DD>Converts the collection to a string representation for debugging. - WARNING: The returned string may be very large. -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the string representation. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> -<HR> - -<A NAME="size()"><!-- --></A><H3> -size</H3> -<PRE> -public int <B>size</B>()</PRE> -<DL> -<DD><B>Description copied from class: <CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#size()">StoredContainer</A></CODE></B></DD> -<DD>Returns a non-transactional count of the records in the collection or - map. This method conforms to the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#size()" title="class or interface in java.util"><CODE>Collection.size()</CODE></A> and - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#size()" title="class or interface in java.util"><CODE>Map.size()</CODE></A> interfaces. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#size()" title="class or interface in java.util">size</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#size()">size</A></CODE> in class <CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)"><!-- --></A><H3> -join</H3> -<PRE> -public <A HREF="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A><<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</A>> <B>join</B>(<A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A>[] indices, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] indexKeys, - <A HREF="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A> joinConfig)</PRE> -<DL> -<DD>Returns an iterator representing an equality join of the indices and + This method conforms to the <code>Collection.equals(java.lang.Object)</code> interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hashCode</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> 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="strong">Returns:</span></dt><dd>an <code>ArrayList</code> containing a copy of all elements in this + collection.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String 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><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the string representation.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown, + including a <code>DatabaseException</code> on BDB (C Edition).</dd></dl> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/sleepycat/collections/StoredContainer.html#size()">StoredContainer</a></code></strong></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.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/collections/StoredContainer.html#size()">size</a></code> in class <code><a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>join</h4> +<pre>public <a href="../../../com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</a><<a href="../../../com/sleepycat/collections/StoredCollection.html" title="type parameter in StoredCollection">E</a>> join(<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>[] indices, + java.lang.Object[] indexKeys, + <a href="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</a> 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 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. + 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 + 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>indices</CODE> - is an array of indices with elements corresponding to - those in the indexKeys array.<DD><CODE>indexKeys</CODE> - is an array of index key values identifying the - elements to be selected.<DD><CODE>joinConfig</CODE> - is the join configuration, or null to use the - default configuration. -<DT><B>Returns:</B><DD>an iterator over the elements in this collection that match - all specified index key values. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this collection is indexed or if a - given index does not have the same store as this collection. -<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a checked exception is thrown, - including a <code>DatabaseException</code> on BDB (C Edition).</DL> -</DD> -</DL> + next(). All other methods will throw UnsupportedOperationException.</p></div> +<dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>an iterator over the elements in this collection that match + all specified index key values.</dd> +<dt><span class="strong">Throws:</span></dt> +<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 ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/collections/StoredCollection.html" target="_top"><B>FRAMES</B></A> - <A HREF="StoredCollection.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/collections/StoredCollection.html" target="_top">Frames</a></li> +<li><a href="StoredCollection.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |