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> 7StoredContainer (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="StoredContainer (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/StoredContainer.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/StoredCollections.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/collections/StoredEntrySet.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/StoredContainer.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="StoredContainer.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | 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 StoredContainer</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 "><B>com.sleepycat.collections.StoredContainer</B> 97</PRE> 98<DL> 99<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></DD> 100</DL> 101<DL> 102<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A>, <A HREF="../../../com/sleepycat/collections/StoredMap.html" title="class in com.sleepycat.collections">StoredMap</A></DD> 103</DL> 104<HR> 105<DL> 106<DT><PRE>public abstract class <B>StoredContainer</B><DT>extends <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><DT>implements <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></DL> 107</PRE> 108 109<P> 110A abstract base class for all stored collections and maps. This class 111 provides implementations of methods that are common to 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> and the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> interfaces, namely 112 <A HREF="../../../com/sleepycat/collections/StoredContainer.html#clear()"><CODE>clear()</CODE></A>, <A HREF="../../../com/sleepycat/collections/StoredContainer.html#isEmpty()"><CODE>isEmpty()</CODE></A> and <A HREF="../../../com/sleepycat/collections/StoredContainer.html#size()"><CODE>size()</CODE></A>. 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/StoredContainer.html#isWriteAllowed()"><CODE>isWriteAllowed()</CODE></A></li> 119 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isSecondary()"><CODE>isSecondary()</CODE></A></li> 120 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isOrdered()"><CODE>isOrdered()</CODE></A></li> 121 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()"><CODE>areKeyRangesAllowed()</CODE></A></li> 122 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()"><CODE>areDuplicatesAllowed()</CODE></A></li> 123 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()"><CODE>areDuplicatesOrdered()</CODE></A></li> 124 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()"><CODE>areKeysRenumbered()</CODE></A></li> 125 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()"><CODE>getCursorConfig()</CODE></A></li> 126 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isTransactional()"><CODE>isTransactional()</CODE></A></li> 127 </ul> 128<P> 129 130<P> 131<HR> 132 133<P> 134 135<!-- ========== METHOD SUMMARY =========== --> 136 137<A NAME="method_summary"><!-- --></A> 138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 140<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 141<B>Method Summary</B></FONT></TH> 142</TR> 143<TR BGCOLOR="white" CLASS="TableRowColor"> 144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145<CODE> boolean</CODE></FONT></TD> 146<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</A></B>()</CODE> 147 148<BR> 149 Returns whether duplicate keys are allowed in this container.</TD> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 153<CODE> boolean</CODE></FONT></TD> 154<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</A></B>()</CODE> 155 156<BR> 157 Returns whether duplicate keys are allowed and sorted by element value.</TD> 158</TR> 159<TR BGCOLOR="white" CLASS="TableRowColor"> 160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 161<CODE> boolean</CODE></FONT></TD> 162<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()">areKeyRangesAllowed</A></B>()</CODE> 163 164<BR> 165 Returns whether key ranges are allowed in this container.</TD> 166</TR> 167<TR BGCOLOR="white" CLASS="TableRowColor"> 168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 169<CODE> boolean</CODE></FONT></TD> 170<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</A></B>()</CODE> 171 172<BR> 173 Returns whether keys are renumbered when insertions and deletions occur.</TD> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 177<CODE> void</CODE></FONT></TD> 178<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#clear()">clear</A></B>()</CODE> 179 180<BR> 181 Removes all mappings or elements from this map or collection (optional 182 operation).</TD> 183</TR> 184<TR BGCOLOR="white" CLASS="TableRowColor"> 185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 186<CODE> <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A></CODE></FONT></TD> 187<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()">getCursorConfig</A></B>()</CODE> 188 189<BR> 190 Returns the cursor configuration that is used for all operations 191 performed via this container.</TD> 192</TR> 193<TR BGCOLOR="white" CLASS="TableRowColor"> 194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 195<CODE> boolean</CODE></FONT></TD> 196<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isEmpty()">isEmpty</A></B>()</CODE> 197 198<BR> 199 Returns true if this map or collection contains no mappings or elements.</TD> 200</TR> 201<TR BGCOLOR="white" CLASS="TableRowColor"> 202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 203<CODE> boolean</CODE></FONT></TD> 204<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isOrdered()">isOrdered</A></B>()</CODE> 205 206<BR> 207 Returns whether keys are ordered in this container.</TD> 208</TR> 209<TR BGCOLOR="white" CLASS="TableRowColor"> 210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 211<CODE> boolean</CODE></FONT></TD> 212<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isSecondary()">isSecondary</A></B>()</CODE> 213 214<BR> 215 Returns whether this container is a view on a secondary database rather 216 than directly on a primary database.</TD> 217</TR> 218<TR BGCOLOR="white" CLASS="TableRowColor"> 219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 220<CODE> boolean</CODE></FONT></TD> 221<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isTransactional()">isTransactional</A></B>()</CODE> 222 223<BR> 224 Returns whether the databases underlying this container are 225 transactional.</TD> 226</TR> 227<TR BGCOLOR="white" CLASS="TableRowColor"> 228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 229<CODE> boolean</CODE></FONT></TD> 230<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()">isWriteAllowed</A></B>()</CODE> 231 232<BR> 233 Returns true if this is a read-write container or false if this is a 234 read-only container.</TD> 235</TR> 236<TR BGCOLOR="white" CLASS="TableRowColor"> 237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 238<CODE>abstract int</CODE></FONT></TD> 239<TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredContainer.html#size()">size</A></B>()</CODE> 240 241<BR> 242 Returns a non-transactional count of the records in the collection or 243 map.</TD> 244</TR> 245</TABLE> 246 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 248<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 249<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> 250</TR> 251<TR BGCOLOR="white" CLASS="TableRowColor"> 252<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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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> 253</TR> 254</TABLE> 255 256<P> 257 258<!-- ============ METHOD DETAIL ========== --> 259 260<A NAME="method_detail"><!-- --></A> 261<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 262<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 263<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 264<B>Method Detail</B></FONT></TH> 265</TR> 266</TABLE> 267 268<A NAME="isWriteAllowed()"><!-- --></A><H3> 269isWriteAllowed</H3> 270<PRE> 271public final boolean <B>isWriteAllowed</B>()</PRE> 272<DL> 273<DD>Returns true if this is a read-write container or false if this is a 274 read-only container. 275 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 276 <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> interfaces. 277<P> 278<DD><DL> 279</DL> 280</DD> 281<DD><DL> 282 283<DT><B>Returns:</B><DD>whether write is allowed.</DL> 284</DD> 285</DL> 286<HR> 287 288<A NAME="getCursorConfig()"><!-- --></A><H3> 289getCursorConfig</H3> 290<PRE> 291public final <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> <B>getCursorConfig</B>()</PRE> 292<DL> 293<DD>Returns the cursor configuration that is used for all operations 294 performed via this container. 295 For example, if <code>CursorConfig.getReadUncommitted</code> returns 296 true, data will be read that is modified but not committed. 297 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 298 <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> interfaces. 299<P> 300<DD><DL> 301</DL> 302</DD> 303<DD><DL> 304 305<DT><B>Returns:</B><DD>the cursor configuration, or null if no configuration has been 306 specified.</DL> 307</DD> 308</DL> 309<HR> 310 311<A NAME="isTransactional()"><!-- --></A><H3> 312isTransactional</H3> 313<PRE> 314public final boolean <B>isTransactional</B>()</PRE> 315<DL> 316<DD>Returns whether the databases underlying this container are 317 transactional. 318 Even in a transactional environment, a database will be transactional 319 only if it was opened within a transaction or if the auto-commit option 320 was specified when it was opened. 321 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 322 <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> interfaces. 323<P> 324<DD><DL> 325</DL> 326</DD> 327<DD><DL> 328 329<DT><B>Returns:</B><DD>whether the database is transactional.</DL> 330</DD> 331</DL> 332<HR> 333 334<A NAME="areDuplicatesAllowed()"><!-- --></A><H3> 335areDuplicatesAllowed</H3> 336<PRE> 337public final boolean <B>areDuplicatesAllowed</B>()</PRE> 338<DL> 339<DD>Returns whether duplicate keys are allowed in this container. 340 Duplicates are optionally allowed for HASH and BTREE databases. 341 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 342 <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> interfaces. 343 344 <p>Note that the JE product only supports BTREE databases.</p> 345<P> 346<DD><DL> 347</DL> 348</DD> 349<DD><DL> 350 351<DT><B>Returns:</B><DD>whether duplicates are allowed.</DL> 352</DD> 353</DL> 354<HR> 355 356<A NAME="areDuplicatesOrdered()"><!-- --></A><H3> 357areDuplicatesOrdered</H3> 358<PRE> 359public final boolean <B>areDuplicatesOrdered</B>()</PRE> 360<DL> 361<DD>Returns whether duplicate keys are allowed and sorted by element value. 362 Duplicates are optionally sorted for HASH and BTREE databases. 363 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 364 <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> interfaces. 365 366 <p>Note that the JE product only supports BTREE databases, and 367 duplicates are always sorted.</p> 368<P> 369<DD><DL> 370</DL> 371</DD> 372<DD><DL> 373 374<DT><B>Returns:</B><DD>whether duplicates are ordered.</DL> 375</DD> 376</DL> 377<HR> 378 379<A NAME="areKeysRenumbered()"><!-- --></A><H3> 380areKeysRenumbered</H3> 381<PRE> 382public final boolean <B>areKeysRenumbered</B>()</PRE> 383<DL> 384<DD>Returns whether keys are renumbered when insertions and deletions occur. 385 Keys are optionally renumbered for RECNO databases. 386 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 387 <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> interfaces. 388 389 <p>Note that the JE product does not support RECNO databases, and 390 therefore keys are never renumbered.</p> 391<P> 392<DD><DL> 393</DL> 394</DD> 395<DD><DL> 396 397<DT><B>Returns:</B><DD>whether keys are renumbered.</DL> 398</DD> 399</DL> 400<HR> 401 402<A NAME="isOrdered()"><!-- --></A><H3> 403isOrdered</H3> 404<PRE> 405public final boolean <B>isOrdered</B>()</PRE> 406<DL> 407<DD>Returns whether keys are ordered in this container. 408 Keys are ordered for BTREE, RECNO and QUEUE databases. 409 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 410 <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> interfaces. 411 412 <p>Note that the JE product only support BTREE databases, and 413 therefore keys are always ordered.</p> 414<P> 415<DD><DL> 416</DL> 417</DD> 418<DD><DL> 419 420<DT><B>Returns:</B><DD>whether keys are ordered.</DL> 421</DD> 422</DL> 423<HR> 424 425<A NAME="areKeyRangesAllowed()"><!-- --></A><H3> 426areKeyRangesAllowed</H3> 427<PRE> 428public final boolean <B>areKeyRangesAllowed</B>()</PRE> 429<DL> 430<DD>Returns whether key ranges are allowed in this container. 431 Key ranges are allowed only for BTREE databases. 432 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 433 <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> interfaces. 434 435 <p>Note that the JE product only supports BTREE databases, and 436 therefore key ranges are always allowed.</p> 437<P> 438<DD><DL> 439</DL> 440</DD> 441<DD><DL> 442 443<DT><B>Returns:</B><DD>whether keys are ordered.</DL> 444</DD> 445</DL> 446<HR> 447 448<A NAME="isSecondary()"><!-- --></A><H3> 449isSecondary</H3> 450<PRE> 451public final boolean <B>isSecondary</B>()</PRE> 452<DL> 453<DD>Returns whether this container is a view on a secondary database rather 454 than directly on a primary database. 455 This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or 456 <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> interfaces. 457<P> 458<DD><DL> 459</DL> 460</DD> 461<DD><DL> 462 463<DT><B>Returns:</B><DD>whether the view is for a secondary database.</DL> 464</DD> 465</DL> 466<HR> 467 468<A NAME="size()"><!-- --></A><H3> 469size</H3> 470<PRE> 471public abstract int <B>size</B>()</PRE> 472<DL> 473<DD>Returns a non-transactional count of the records in the collection or 474 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 475 <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. 476<P> 477<DD><DL> 478</DL> 479</DD> 480<DD><DL> 481 482<DT><B>Throws:</B> 483<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> 484</DD> 485</DL> 486<HR> 487 488<A NAME="isEmpty()"><!-- --></A><H3> 489isEmpty</H3> 490<PRE> 491public boolean <B>isEmpty</B>()</PRE> 492<DL> 493<DD>Returns true if this map or collection contains no mappings or elements. 494 This method conforms to the <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"><CODE>Collection.isEmpty()</CODE></A> and 495 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util"><CODE>Map.isEmpty()</CODE></A> interfaces. 496<P> 497<DD><DL> 498</DL> 499</DD> 500<DD><DL> 501 502<DT><B>Returns:</B><DD>whether the container is empty. 503<DT><B>Throws:</B> 504<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> 505</DD> 506</DL> 507<HR> 508 509<A NAME="clear()"><!-- --></A><H3> 510clear</H3> 511<PRE> 512public void <B>clear</B>()</PRE> 513<DL> 514<DD>Removes all mappings or elements from this map or collection (optional 515 operation). 516 This method conforms to the <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"><CODE>Collection.clear()</CODE></A> and 517 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util"><CODE>Map.clear()</CODE></A> interfaces. 518<P> 519<DD><DL> 520</DL> 521</DD> 522<DD><DL> 523 524<DT><B>Throws:</B> 525<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 container is read-only. 526<DD><CODE><A HREF="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</A></CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> 527</DD> 528</DL> 529<!-- ========= END OF CLASS DATA ========= --> 530<HR> 531 532 533<!-- ======= START OF BOTTOM NAVBAR ====== --> 534<A NAME="navbar_bottom"><!-- --></A> 535<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 536<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 537<TR> 538<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 539<A NAME="navbar_bottom_firstrow"><!-- --></A> 540<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 541 <TR ALIGN="center" VALIGN="top"> 542 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 543 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 544 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 545 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 546 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 547 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 548 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 549 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 550 </TR> 551</TABLE> 552</TD> 553<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 554<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 555</TD> 556</TR> 557 558<TR> 559<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 560 <A HREF="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> 561 <A HREF="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> 562<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 563 <A HREF="../../../index.html?com/sleepycat/collections/StoredContainer.html" target="_top"><B>FRAMES</B></A> 564 <A HREF="StoredContainer.html" target="_top"><B>NO FRAMES</B></A> 565 <SCRIPT type="text/javascript"> 566 <!-- 567 if(window==top) { 568 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 569 } 570 //--> 571</SCRIPT> 572<NOSCRIPT> 573 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 574</NOSCRIPT> 575 576 577</FONT></TD> 578</TR> 579<TR> 580<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 581 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 582<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 583DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 584</TR> 585</TABLE> 586<A NAME="skip-navbar_bottom"></A> 587<!-- ======== END OF BOTTOM NAVBAR ======= --> 588 589<HR> 590<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 591</BODY> 592</HTML> 593
