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