1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:32 EDT 2008 --> 6<TITLE> 7StoredCollection (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.collections.StoredCollection class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="StoredCollection (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="/com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><B>PREV CLASS</B></A> 56 <A HREF="/com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="/index.html?com/sleepycat/collections/StoredCollection.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="StoredCollection.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.collections</FONT> 89<BR> 90Class StoredCollection</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <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> 94 <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>com.sleepycat.collections.StoredCollection</B> 95</PRE> 96<DL> 97<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></DD> 98</DL> 99<DL> 100<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> 101</DL> 102<HR> 103<DL> 104<DT><PRE>public abstract class <B>StoredCollection</B><DT>extends <A HREF="/com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></DL> 105</PRE> 106 107<P> 108A abstract base class for all stored collections. This class, and its 109 base class <A HREF="/com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections"><CODE>StoredContainer</CODE></A>, provide implementations of most methods 110 in the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" 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> 111 and <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#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 112 class. 113 114 <p>In addition, this class provides the following methods for stored 115 collections only. Note that the use of these methods is not compatible with 116 the standard Java collections interface.</p> 117 <ul> 118 <li><A HREF="/com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()"><CODE>getIteratorBlockSize()</CODE></A></li> 119 <li><A HREF="/com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)"><CODE>setIteratorBlockSize(int)</CODE></A></li> 120 <li><A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator()"><CODE>storedIterator()</CODE></A></li> 121 <li><A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)"><CODE>storedIterator(boolean)</CODE></A></li> 122 <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> 123 <li><A HREF="/com/sleepycat/collections/StoredCollection.html#toList()"><CODE>toList()</CODE></A></li> 124 </ul> 125<P> 126 127<P> 128<HR> 129 130<P> 131<!-- =========== FIELD SUMMARY =========== --> 132 133<A NAME="field_summary"><!-- --></A> 134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 136<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 137<B>Field Summary</B></FONT></TH> 138</TR> 139<TR BGCOLOR="white" CLASS="TableRowColor"> 140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 141<CODE>static int</CODE></FONT></TD> 142<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</A></B></CODE> 143 144<BR> 145 The default number of records read at one time by iterators.</TD> 146</TR> 147</TABLE> 148 149<!-- ========== METHOD SUMMARY =========== --> 150 151<A NAME="method_summary"><!-- --></A> 152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 155<B>Method Summary</B></FONT></TH> 156</TR> 157<TR BGCOLOR="white" CLASS="TableRowColor"> 158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 159<CODE> boolean</CODE></FONT></TD> 160<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)">addAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</CODE> 161 162<BR> 163 Adds all of the elements in the specified collection to this collection 164 (optional operation).</TD> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 168<CODE> boolean</CODE></FONT></TD> 169<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#containsAll(java.util.Collection)">containsAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</CODE> 170 171<BR> 172 Returns true if this collection contains all of the elements in the 173 specified collection.</TD> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 177<CODE> boolean</CODE></FONT></TD> 178<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</CODE> 179 180<BR> 181 Compares the specified object with this collection for equality.</TD> 182</TR> 183<TR BGCOLOR="white" CLASS="TableRowColor"> 184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 185<CODE> int</CODE></FONT></TD> 186<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()">getIteratorBlockSize</A></B>()</CODE> 187 188<BR> 189 Returns the number of records read at one time by iterators returned by 190 the <A HREF="/com/sleepycat/collections/StoredCollection.html#iterator()"><CODE>iterator()</CODE></A> method.</TD> 191</TR> 192<TR BGCOLOR="white" CLASS="TableRowColor"> 193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 194<CODE> int</CODE></FONT></TD> 195<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#hashCode()">hashCode</A></B>()</CODE> 196 197<BR> 198 </TD> 199</TR> 200<TR BGCOLOR="white" CLASS="TableRowColor"> 201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 202<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> 203<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#iterator()">iterator</A></B>()</CODE> 204 205<BR> 206 Returns an iterator over the elements in this collection.</TD> 207</TR> 208<TR BGCOLOR="white" CLASS="TableRowColor"> 209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 210<CODE> <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A></CODE></FONT></TD> 211<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#iterator(boolean)">iterator</A></B>(boolean writeAllowed)</CODE> 212 213<BR> 214 <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 215 be closed, the method name <code>iterator</code> is confusing since standard 216 Java iterators do not need to be closed.</I></TD> 217</TR> 218<TR BGCOLOR="white" CLASS="TableRowColor"> 219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 220<CODE> <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A></CODE></FONT></TD> 221<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, 222 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] indexKeys, 223 <A HREF="/com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A> joinConfig)</CODE> 224 225<BR> 226 Returns an iterator representing an equality join of the indices and 227 index key values specified.</TD> 228</TR> 229<TR BGCOLOR="white" CLASS="TableRowColor"> 230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 231<CODE> boolean</CODE></FONT></TD> 232<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</CODE> 233 234<BR> 235 Removes all this collection's elements that are also contained in the 236 specified collection (optional operation).</TD> 237</TR> 238<TR BGCOLOR="white" CLASS="TableRowColor"> 239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 240<CODE> boolean</CODE></FONT></TD> 241<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#retainAll(java.util.Collection)">retainAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</CODE> 242 243<BR> 244 Retains only the elements in this collection that are contained in the 245 specified collection (optional operation).</TD> 246</TR> 247<TR BGCOLOR="white" CLASS="TableRowColor"> 248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 249<CODE> void</CODE></FONT></TD> 250<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)">setIteratorBlockSize</A></B>(int blockSize)</CODE> 251 252<BR> 253 Changes the number of records read at one time by iterators returned by 254 the <A HREF="/com/sleepycat/collections/StoredCollection.html#iterator()"><CODE>iterator()</CODE></A> method.</TD> 255</TR> 256<TR BGCOLOR="white" CLASS="TableRowColor"> 257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 258<CODE> int</CODE></FONT></TD> 259<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#size()">size</A></B>()</CODE> 260 261<BR> 262 Returns a non-transactional count of the records in the collection or 263 map.</TD> 264</TR> 265<TR BGCOLOR="white" CLASS="TableRowColor"> 266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 267<CODE> <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A></CODE></FONT></TD> 268<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator()">storedIterator</A></B>()</CODE> 269 270<BR> 271 Returns an iterator over the elements in this collection.</TD> 272</TR> 273<TR BGCOLOR="white" CLASS="TableRowColor"> 274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 275<CODE> <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A></CODE></FONT></TD> 276<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)">storedIterator</A></B>(boolean writeAllowed)</CODE> 277 278<BR> 279 Returns a read or read-write iterator over the elements in this 280 collection.</TD> 281</TR> 282<TR BGCOLOR="white" CLASS="TableRowColor"> 283<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 284<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> 285<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#toArray()">toArray</A></B>()</CODE> 286 287<BR> 288 Returns an array of all the elements in this collection.</TD> 289</TR> 290<TR BGCOLOR="white" CLASS="TableRowColor"> 291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 292<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> 293<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#toArray(java.lang.Object[])">toArray</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] a)</CODE> 294 295<BR> 296 Returns an array of all the elements in this collection whose runtime 297 type is that of the specified array.</TD> 298</TR> 299<TR BGCOLOR="white" CLASS="TableRowColor"> 300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 301<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD> 302<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#toList()">toList</A></B>()</CODE> 303 304<BR> 305 Returns a copy of this collection as an ArrayList.</TD> 306</TR> 307<TR BGCOLOR="white" CLASS="TableRowColor"> 308<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 309<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> 310<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredCollection.html#toString()">toString</A></B>()</CODE> 311 312<BR> 313 Converts the collection to a string representation for debugging.</TD> 314</TR> 315</TABLE> 316 <A NAME="methods_inherited_from_class_com.sleepycat.collections.StoredContainer"><!-- --></A> 317<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 318<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 319<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> 320</TR> 321<TR BGCOLOR="white" CLASS="TableRowColor"> 322<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#isDirtyRead()">isDirtyRead</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isDirtyReadAllowed()">isDirtyReadAllowed</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> 323</TR> 324</TABLE> 325 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 326<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 327<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 328<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 329</TR> 330<TR BGCOLOR="white" CLASS="TableRowColor"> 331<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 332</TR> 333</TABLE> 334 <A NAME="methods_inherited_from_class_java.util.Collection"><!-- --></A> 335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 336<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 337<TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></B></TH> 338</TR> 339<TR BGCOLOR="white" CLASS="TableRowColor"> 340<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#add(E)" title="class or interface in java.util">add</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#contains(java.lang.Object)" title="class or interface in java.util">contains</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE></TD> 341</TR> 342</TABLE> 343 344<P> 345 346<!-- ============ FIELD DETAIL =========== --> 347 348<A NAME="field_detail"><!-- --></A> 349<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 350<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 351<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 352<B>Field Detail</B></FONT></TH> 353</TR> 354</TABLE> 355 356<A NAME="DEFAULT_ITERATOR_BLOCK_SIZE"><!-- --></A><H3> 357DEFAULT_ITERATOR_BLOCK_SIZE</H3> 358<PRE> 359public static final int <B>DEFAULT_ITERATOR_BLOCK_SIZE</B></PRE> 360<DL> 361<DD>The default number of records read at one time by iterators. 362<P> 363<DL> 364<DT><B>See Also:</B><DD><A HREF="/com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)"><CODE>setIteratorBlockSize(int)</CODE></A>, 365<A HREF="/constant-values.html#com.sleepycat.collections.StoredCollection.DEFAULT_ITERATOR_BLOCK_SIZE">Constant Field Values</A></DL> 366</DL> 367 368<!-- ============ METHOD DETAIL ========== --> 369 370<A NAME="method_detail"><!-- --></A> 371<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 372<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 373<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 374<B>Method Detail</B></FONT></TH> 375</TR> 376</TABLE> 377 378<A NAME="getIteratorBlockSize()"><!-- --></A><H3> 379getIteratorBlockSize</H3> 380<PRE> 381public int <B>getIteratorBlockSize</B>()</PRE> 382<DL> 383<DD>Returns the number of records read at one time by iterators returned by 384 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>. 385<P> 386<DD><DL> 387</DL> 388</DD> 389<DD><DL> 390</DL> 391</DD> 392</DL> 393<HR> 394 395<A NAME="setIteratorBlockSize(int)"><!-- --></A><H3> 396setIteratorBlockSize</H3> 397<PRE> 398public void <B>setIteratorBlockSize</B>(int blockSize)</PRE> 399<DL> 400<DD>Changes the number of records read at one time by iterators returned by 401 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>. 402<P> 403<DD><DL> 404</DL> 405</DD> 406<DD><DL> 407 408<DT><B>Throws:</B> 409<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the blockSize is less than two.</DL> 410</DD> 411</DL> 412<HR> 413 414<A NAME="iterator()"><!-- --></A><H3> 415iterator</H3> 416<PRE> 417public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A> <B>iterator</B>()</PRE> 418<DL> 419<DD>Returns an iterator over the elements in this collection. 420 The iterator will be read-only if the collection is read-only. 421 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#iterator()" title="class or interface in java.util"><CODE>Collection.iterator()</CODE></A> interface. 422 423 <p>The iterator returned by this method does not keep a database cursor 424 open and therefore it does not need to be closed. It reads blocks of 425 records as needed, opening and closing a cursor to read each block of 426 records. The number of records per block is 10 by default and can be 427 changed with <A HREF="/com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)"><CODE>setIteratorBlockSize(int)</CODE></A>.</p> 428 429 <p>Because this iterator does not keep a cursor open, if it is used 430 without transactions, the iterator does not have <em>cursor 431 stability</em> characteristics. In other words, the record at the 432 current iterator position can be changed or deleted by another thread. 433 To prevent this from happening, call this method within a transaction or 434 use the <A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator()"><CODE>storedIterator()</CODE></A> method instead.</p> 435<P> 436<DD><DL> 437<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#iterator()" title="class or interface in java.util">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 438</DD> 439<DD><DL> 440 441<DT><B>Returns:</B><DD>a standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" 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> 442</DD> 443</DL> 444<HR> 445 446<A NAME="storedIterator()"><!-- --></A><H3> 447storedIterator</H3> 448<PRE> 449public <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A> <B>storedIterator</B>()</PRE> 450<DL> 451<DD>Returns an iterator over the elements in this collection. 452 The iterator will be read-only if the collection is read-only. 453 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. 454 455 <p>If <code>Iterator.set</code> or <code>Iterator.remove</code> will be called 456 and the underlying Database is transactional, then a transaction must be 457 active when calling this method and must remain active while using the 458 iterator.</p> 459 460 <p><strong>Warning:</strong> The iterator returned must be explicitly 461 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 462 database cursor resources.</p> 463<P> 464<DD><DL> 465</DL> 466</DD> 467<DD><DL> 468 469<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> 470</DD> 471</DL> 472<HR> 473 474<A NAME="storedIterator(boolean)"><!-- --></A><H3> 475storedIterator</H3> 476<PRE> 477public <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A> <B>storedIterator</B>(boolean writeAllowed)</PRE> 478<DL> 479<DD>Returns a read or read-write iterator over the elements in this 480 collection. 481 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. 482 483 <p>If <code>Iterator.set</code> or <code>Iterator.remove</code> will be called 484 and the underlying Database is transactional, then a transaction must be 485 active when calling this method and must remain active while using the 486 iterator.</p> 487 488 <p><strong>Warning:</strong> The iterator returned must be explicitly 489 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 490 database cursor resources.</p> 491<P> 492<DD><DL> 493</DL> 494</DD> 495<DD><DL> 496<DT><B>Parameters:</B><DD><CODE>writeAllowed</CODE> - is true to open a read-write iterator or false to 497 open a read-only iterator. If the collection is read-only the iterator 498 will always be read-only. 499<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. 500<DT><B>Throws:</B> 501<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if writeAllowed is true but the collection 502 is read-only. 503<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 504 thrown.<DT><B>See Also:</B><DD><A HREF="/com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> 505</DD> 506</DL> 507<HR> 508 509<A NAME="iterator(boolean)"><!-- --></A><H3> 510iterator</H3> 511<PRE> 512public <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A> <B>iterator</B>(boolean writeAllowed)</PRE> 513<DL> 514<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 515 be closed, the method name <code>iterator</code> is confusing since standard 516 Java iterators do not need to be closed.</I> 517<P> 518<DD><DL> 519</DL> 520</DD> 521<DD><DL> 522</DL> 523</DD> 524</DL> 525<HR> 526 527<A NAME="toArray()"><!-- --></A><H3> 528toArray</H3> 529<PRE> 530public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>toArray</B>()</PRE> 531<DL> 532<DD>Returns an array of all the elements in this collection. 533 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#toArray()" title="class or interface in java.util"><CODE>Collection.toArray()</CODE></A> interface. 534<P> 535<DD><DL> 536<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#toArray()" title="class or interface in java.util">toArray</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 537</DD> 538<DD><DL> 539 540<DT><B>Throws:</B> 541<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 542 thrown.</DL> 543</DD> 544</DL> 545<HR> 546 547<A NAME="toArray(java.lang.Object[])"><!-- --></A><H3> 548toArray</H3> 549<PRE> 550public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>toArray</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] a)</PRE> 551<DL> 552<DD>Returns an array of all the elements in this collection whose runtime 553 type is that of the specified array. 554 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#toArray(T[])" title="class or interface in java.util"><CODE>Collection.toArray(Object[])</CODE></A> 555 interface. 556<P> 557<DD><DL> 558<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#toArray(T[])" title="class or interface in java.util">toArray</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 559</DD> 560<DD><DL> 561 562<DT><B>Throws:</B> 563<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 564 thrown.</DL> 565</DD> 566</DL> 567<HR> 568 569<A NAME="containsAll(java.util.Collection)"><!-- --></A><H3> 570containsAll</H3> 571<PRE> 572public boolean <B>containsAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</PRE> 573<DL> 574<DD>Returns true if this collection contains all of the elements in the 575 specified collection. 576 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#containsAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.containsAll(java.util.Collection<?>)</CODE></A> interface. 577<P> 578<DD><DL> 579<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 580</DD> 581<DD><DL> 582 583<DT><B>Throws:</B> 584<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 585 thrown.</DL> 586</DD> 587</DL> 588<HR> 589 590<A NAME="addAll(java.util.Collection)"><!-- --></A><H3> 591addAll</H3> 592<PRE> 593public boolean <B>addAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</PRE> 594<DL> 595<DD>Adds all of the elements in the specified collection to this collection 596 (optional operation). 597 This method calls the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#add(E)" title="class or interface in java.util"><CODE>Collection.add(Object)</CODE></A> method of the concrete 598 collection class, which may or may not be supported. 599 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#addAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.addAll(java.util.Collection<? extends E>)</CODE></A> interface. 600<P> 601<DD><DL> 602<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 603</DD> 604<DD><DL> 605 606<DT><B>Throws:</B> 607<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only, or 608 if the collection is indexed, or if the add method is not supported by 609 the concrete collection. 610<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 611 thrown.</DL> 612</DD> 613</DL> 614<HR> 615 616<A NAME="removeAll(java.util.Collection)"><!-- --></A><H3> 617removeAll</H3> 618<PRE> 619public boolean <B>removeAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</PRE> 620<DL> 621<DD>Removes all this collection's elements that are also contained in the 622 specified collection (optional operation). 623 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#removeAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.removeAll(java.util.Collection<?>)</CODE></A> interface. 624<P> 625<DD><DL> 626<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 627</DD> 628<DD><DL> 629 630<DT><B>Throws:</B> 631<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only. 632<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 633 thrown.</DL> 634</DD> 635</DL> 636<HR> 637 638<A NAME="retainAll(java.util.Collection)"><!-- --></A><H3> 639retainAll</H3> 640<PRE> 641public boolean <B>retainAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> coll)</PRE> 642<DL> 643<DD>Retains only the elements in this collection that are contained in the 644 specified collection (optional operation). 645 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#removeAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.removeAll(java.util.Collection<?>)</CODE></A> interface. 646<P> 647<DD><DL> 648<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></DL> 649</DD> 650<DD><DL> 651 652<DT><B>Throws:</B> 653<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only. 654<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 655 thrown.</DL> 656</DD> 657</DL> 658<HR> 659 660<A NAME="equals(java.lang.Object)"><!-- --></A><H3> 661equals</H3> 662<PRE> 663public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</PRE> 664<DL> 665<DD>Compares the specified object with this collection for equality. 666 A value comparison is performed by this method and the stored values 667 are compared rather than calling the equals() method of each element. 668 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#equals(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.equals(java.lang.Object)</CODE></A> interface. 669<P> 670<DD><DL> 671<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#equals(java.lang.Object)" title="class or interface in java.util">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> 672</DD> 673<DD><DL> 674 675<DT><B>Throws:</B> 676<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 677 thrown.</DL> 678</DD> 679</DL> 680<HR> 681 682<A NAME="hashCode()"><!-- --></A><H3> 683hashCode</H3> 684<PRE> 685public int <B>hashCode</B>()</PRE> 686<DL> 687<DD><DL> 688<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#hashCode()" title="class or interface in java.util">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> 689</DD> 690<DD><DL> 691</DL> 692</DD> 693</DL> 694<HR> 695 696<A NAME="toList()"><!-- --></A><H3> 697toList</H3> 698<PRE> 699public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>toList</B>()</PRE> 700<DL> 701<DD>Returns a copy of this collection as an ArrayList. This is the same as 702 <A HREF="/com/sleepycat/collections/StoredCollection.html#toArray()"><CODE>toArray()</CODE></A> but returns a collection instead of an array. 703<P> 704<DD><DL> 705</DL> 706</DD> 707<DD><DL> 708 709<DT><B>Returns:</B><DD>an <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ArrayList.html" title="class or interface in java.util"><CODE>ArrayList</CODE></A> containing a copy of all elements in this 710 collection. 711<DT><B>Throws:</B> 712<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 713 thrown.</DL> 714</DD> 715</DL> 716<HR> 717 718<A NAME="toString()"><!-- --></A><H3> 719toString</H3> 720<PRE> 721public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 722<DL> 723<DD>Converts the collection to a string representation for debugging. 724 WARNING: The returned string may be very large. 725<P> 726<DD><DL> 727<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> 728</DD> 729<DD><DL> 730 731<DT><B>Returns:</B><DD>the string representation. 732<DT><B>Throws:</B> 733<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 734 thrown.</DL> 735</DD> 736</DL> 737<HR> 738 739<A NAME="size()"><!-- --></A><H3> 740size</H3> 741<PRE> 742public int <B>size</B>()</PRE> 743<DL> 744<DD><B>Description copied from class: <CODE><A HREF="/com/sleepycat/collections/StoredContainer.html#size()">StoredContainer</A></CODE></B></DD> 745<DD>Returns a non-transactional count of the records in the collection or 746 map. This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#size()" title="class or interface in java.util"><CODE>Collection.size()</CODE></A> and 747 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html#size()" title="class or interface in java.util"><CODE>Map.size()</CODE></A> interfaces. 748<P> 749<DD><DL> 750<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#size()" title="class or interface in java.util">size</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</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> 751</DD> 752<DD><DL> 753</DL> 754</DD> 755</DL> 756<HR> 757 758<A NAME="join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)"><!-- --></A><H3> 759join</H3> 760<PRE> 761public <A HREF="/com/sleepycat/collections/StoredIterator.html" title="class in com.sleepycat.collections">StoredIterator</A> <B>join</B>(<A HREF="/com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A>[] indices, 762 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] indexKeys, 763 <A HREF="/com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A> joinConfig)</PRE> 764<DL> 765<DD>Returns an iterator representing an equality join of the indices and 766 index key values specified. 767 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> interface. 768 769 <p><strong>Warning:</strong> The iterator returned must be explicitly 770 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 771 database cursor resources.</p> 772 773 <p>The returned iterator supports only the two methods: hasNext() and 774 next(). All other methods will throw UnsupportedOperationException.</p> 775<P> 776<DD><DL> 777</DL> 778</DD> 779<DD><DL> 780<DT><B>Parameters:</B><DD><CODE>indices</CODE> - is an array of indices with elements corresponding to 781 those in the indexKeys array.<DD><CODE>indexKeys</CODE> - is an array of index key values identifying the 782 elements to be selected.<DD><CODE>joinConfig</CODE> - is the join configuration, or null to use the 783 default configuration. 784<DT><B>Returns:</B><DD>an iterator over the elements in this collection that match 785 all specified index key values. 786<DT><B>Throws:</B> 787<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this collection is indexed or if a 788 given index does not have the same store as this collection. 789<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is 790 thrown.</DL> 791</DD> 792</DL> 793<!-- ========= END OF CLASS DATA ========= --> 794<HR> 795 796 797<!-- ======= START OF BOTTOM NAVBAR ====== --> 798<A NAME="navbar_bottom"><!-- --></A> 799<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 800<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 801<TR> 802<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 803<A NAME="navbar_bottom_firstrow"><!-- --></A> 804<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 805 <TR ALIGN="center" VALIGN="top"> 806 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 807 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 808 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 809 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 810 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 811 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 812 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 813 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 814 </TR> 815</TABLE> 816</TD> 817<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 818<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 819</TD> 820</TR> 821 822<TR> 823<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 824 <A HREF="/com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><B>PREV CLASS</B></A> 825 <A HREF="/com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> 826<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 827 <A HREF="/index.html?com/sleepycat/collections/StoredCollection.html" target="_top"><B>FRAMES</B></A> 828 <A HREF="StoredCollection.html" target="_top"><B>NO FRAMES</B></A> 829 <SCRIPT type="text/javascript"> 830 <!-- 831 if(window==top) { 832 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 833 } 834 //--> 835</SCRIPT> 836<NOSCRIPT> 837 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 838</NOSCRIPT> 839 840 841</FONT></TD> 842</TR> 843<TR> 844<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 845 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 846<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 847DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 848</TR> 849</TABLE> 850<A NAME="skip-navbar_bottom"></A> 851<!-- ======== END OF BOTTOM NAVBAR ======= --> 852 853<HR> 854<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 855</BODY> 856</HTML> 857
