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