Edit File - File Manager

Edit File: StoredContainer.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
StoredContainer (Oracle - Berkeley DB Java API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="StoredContainer (Oracle - Berkeley DB Java API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredContainer.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Berkeley DB version 4.7.25
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html?com/sleepycat/collections/StoredContainer.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="StoredContainer.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

com.sleepycat.collections
 
Class StoredContainer</H2>
<PRE>
<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>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">com.sleepycat.collections.StoredContainer
</PRE>
<DL>
<DT>All Implemented Interfaces: <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>
</DL>
<DL>
<DT>Direct Known Subclasses: <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>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class StoredContainer<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>
</PRE>

A abstract base class for all stored collections and maps. This class
 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
 <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>.

In addition, this class provides the following methods for stored
 collections only. Note that the use of these methods is not compatible with
 the standard Java collections interface.
 <ul>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><CODE>isWriteAllowed()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isSecondary()"><CODE>isSecondary()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isOrdered()"><CODE>isOrdered()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()"><CODE>areKeyRangesAllowed()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()"><CODE>areDuplicatesAllowed()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()"><CODE>areDuplicatesOrdered()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()"><CODE>areKeysRenumbered()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()"><CODE>getCursorConfig()</CODE></A></li>
 <li><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isTransactional()"><CODE>isTransactional()</CODE></A></li>
 </ul>

<HR>

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether duplicate keys are allowed in this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether duplicate keys are allowed and sorted by element value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()">areKeyRangesAllowed</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether key ranges are allowed in this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether keys are renumbered when insertions and deletions occur.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#clear()">clear</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all mappings or elements from this map or collection (optional
 operation).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A></CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()">getCursorConfig</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the cursor configuration that is used for all operations
 performed via this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isDirtyRead()">isDirtyRead</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deprecated.&nbsp;This method has been replaced by <A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()"><CODE>getCursorConfig()</CODE></A>.
 <code>CursorConfig.isReadUncommitted</code> may be called to determine
 whether dirty-read is enabled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isDirtyReadAllowed()">isDirtyReadAllowed</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deprecated.&nbsp;This method is deprecated with no replacement in this class.
 In the DB product, <code>DatabaseConfig.getReadUncommitted</code> may be
 called.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isEmpty()">isEmpty</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this map or collection contains no mappings or elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isOrdered()">isOrdered</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether keys are ordered in this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isSecondary()">isSecondary</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether this container is a view on a secondary database rather
 than directly on a primary database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isTransactional()">isTransactional</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the databases underlying this container are
 transactional.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()">isWriteAllowed</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this is a read-write container or false if this is a
 read-only container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>abstract &nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../com/sleepycat/collections/StoredContainer.html#size()">size</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a non-transactional count of the records in the collection or
 map.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">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></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<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>
</TR>
</TABLE>
&nbsp;

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="isWriteAllowed()"></A><H3>
isWriteAllowed</H3>
<PRE>
public final boolean isWriteAllowed()</PRE>
<DL>
<DD>Returns true if this is a read-write container or false if this is a
 read-only container.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether write is allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="getCursorConfig()"></A><H3>
getCursorConfig</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> getCursorConfig()</PRE>
<DL>
<DD>Returns the cursor configuration that is used for all operations
 performed via this container.
 For example, if <code>CursorConfig.getReadUncommitted</code> returns
 true, data will be read that is modified but not committed.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the cursor configuration, or null if no configuration has been
 specified.</DL>
</DD>
</DL>
<HR>

<A NAME="isDirtyReadAllowed()"></A><H3>
isDirtyReadAllowed</H3>
<PRE>
public final boolean isDirtyReadAllowed()</PRE>
<DL>
<DD>Deprecated.&nbsp;This method is deprecated with no replacement in this class.
 In the DB product, <code>DatabaseConfig.getReadUncommitted</code> may be
 called.

<DD>Returns whether read-uncommitted is allowed for this container.
 For the JE product, read-uncommitted is always allowed; for the DB
 product, read-uncommitted is allowed if it was configured for the
 underlying database for this container.
 Even when read-uncommitted is allowed it must specifically be enabled by
 calling one of the <A HREF="../../../com/sleepycat/collections/StoredCollections.html" title="class in com.sleepycat.collections"><CODE>StoredCollections</CODE></A> methods.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether read-uncommitted is allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="isDirtyRead()"></A><H3>
isDirtyRead</H3>
<PRE>
public final boolean isDirtyRead()</PRE>
<DL>
<DD>Deprecated.&nbsp;This method has been replaced by <A HREF="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()"><CODE>getCursorConfig()</CODE></A>.
 <code>CursorConfig.isReadUncommitted</code> may be called to determine
 whether dirty-read is enabled.

<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isTransactional()"></A><H3>
isTransactional</H3>
<PRE>
public final boolean isTransactional()</PRE>
<DL>
<DD>Returns whether the databases underlying this container are
 transactional.
 Even in a transactional environment, a database will be transactional
 only if it was opened within a transaction or if the auto-commit option
 was specified when it was opened.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether the database is transactional.</DL>
</DD>
</DL>
<HR>

<A NAME="areDuplicatesAllowed()"></A><H3>
areDuplicatesAllowed</H3>
<PRE>
public final boolean areDuplicatesAllowed()</PRE>
<DL>
<DD>Returns whether duplicate keys are allowed in this container.
 Duplicates are optionally allowed for HASH and BTREE databases.
 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
 <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.

Note that the JE product only supports BTREE databases.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether duplicates are allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="areDuplicatesOrdered()"></A><H3>
areDuplicatesOrdered</H3>
<PRE>
public final boolean areDuplicatesOrdered()</PRE>
<DL>
<DD>Returns whether duplicate keys are allowed and sorted by element value.
 Duplicates are optionally sorted for HASH and BTREE databases.
 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
 <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.

Note that the JE product only supports BTREE databases, and
 duplicates are always sorted.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether duplicates are ordered.</DL>
</DD>
</DL>
<HR>

<A NAME="areKeysRenumbered()"></A><H3>
areKeysRenumbered</H3>
<PRE>
public final boolean areKeysRenumbered()</PRE>
<DL>
<DD>Returns whether keys are renumbered when insertions and deletions occur.
 Keys are optionally renumbered for RECNO databases.
 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
 <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.

Note that the JE product does not support RECNO databases, and
 therefore keys are never renumbered.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether keys are renumbered.</DL>
</DD>
</DL>
<HR>

<A NAME="isOrdered()"></A><H3>
isOrdered</H3>
<PRE>
public final boolean isOrdered()</PRE>
<DL>
<DD>Returns whether keys are ordered in this container.
 Keys are ordered for BTREE, RECNO and QUEUE databases.
 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
 <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.

Note that the JE product only support BTREE databases, and
 therefore keys are always ordered.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether keys are ordered.</DL>
</DD>
</DL>
<HR>

<A NAME="areKeyRangesAllowed()"></A><H3>
areKeyRangesAllowed</H3>
<PRE>
public final boolean areKeyRangesAllowed()</PRE>
<DL>
<DD>Returns whether key ranges are allowed in this container.
 Key ranges are allowed only for BTREE databases.
 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
 <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.

Note that the JE product only supports BTREE databases, and
 therefore key ranges are always allowed.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether keys are ordered.</DL>
</DD>
</DL>
<HR>

<A NAME="isSecondary()"></A><H3>
isSecondary</H3>
<PRE>
public final boolean isSecondary()</PRE>
<DL>
<DD>Returns whether this container is a view on a secondary database rather
 than directly on a primary database.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether the view is for a secondary database.</DL>
</DD>
</DL>
<HR>

<A NAME="size()"></A><H3>
size</H3>
<PRE>
public abstract int size()</PRE>
<DL>
<DD>Returns a non-transactional count of the records in the collection or
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Throws:
<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>
</DD>
</DL>
<HR>

<A NAME="isEmpty()"></A><H3>
isEmpty</H3>
<PRE>
public boolean isEmpty()</PRE>
<DL>
<DD>Returns true if this map or collection contains no mappings or elements.
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether the container is empty.
<DT>Throws:
<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>
</DD>
</DL>
<HR>

<A NAME="clear()"></A><H3>
clear</H3>
<PRE>
public void clear()</PRE>
<DL>
<DD>Removes all mappings or elements from this map or collection (optional
 operation).
 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
 <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.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Throws:
<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.
<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>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredContainer.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Berkeley DB version 4.7.25
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

Back to File Manager