<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Wed Dec 03 16:22:08 EST 2003 --> <TITLE> StoredMap (Sleepycat Software, Inc. - Berkeley DB Java API) </TITLE> <META NAME="keywords" CONTENT="com.sleepycat.bdb.collection.StoredMap,StoredMap class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="StoredMap (Sleepycat Software, Inc. - Berkeley DB Java API)"; } </SCRIPT> <BODY BGCOLOR="white" onload="asd();"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/collection/StoredList.html"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedEntrySet.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="StoredMap.html" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.sleepycat.bdb.collection</FONT> <BR> Class StoredMap</H2> <PRE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A> | +--<A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">com.sleepycat.bdb.collection.StoredContainer</A> | +--<B>com.sleepycat.bdb.collection.StoredMap</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Cloneable.html">Cloneable</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></DD> </DL> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedMap.html">StoredSortedMap</A></DD> </DL> <HR> <DL> <DT>public class <B>StoredMap</B><DT>extends <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A><DT>implements <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></DL> <P> A Map view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A> or <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>. <p>In addition to the standard Map methods, this class provides the following methods for stored maps only. Note that the use of these methods is not compatible with the standard Java collections interface.</p> <ul> <li><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#duplicates(java.lang.Object)"><CODE>duplicates(Object)</CODE></A></li> <li><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A></li> </ul> <P> <P> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#StoredMap(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, boolean)">StoredMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding, boolean writeAllowed)</CODE> <BR> Creates a map view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#StoredMap(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)">StoredMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</CODE> <BR> Creates a map entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#StoredMap(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, boolean)">StoredMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding, boolean writeAllowed)</CODE> <BR> Creates a map view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#StoredMap(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)">StoredMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</CODE> <BR> Creates a map entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#append(java.lang.Object)">append</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</CODE> <BR> Appends a given value returning the newly assigned key.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#containsKey(java.lang.Object)">containsKey</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</CODE> <BR> Returns true if this map contains the specified key.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#containsValue(java.lang.Object)">containsValue</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</CODE> <BR> Returns true if this map contains the specified value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#duplicates(java.lang.Object)">duplicates</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</CODE> <BR> Returns a new collection containing the values mapped to the given key in this map.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#entrySet()">entrySet</A></B>()</CODE> <BR> Returns a set view of the mappings contained in this map.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> other)</CODE> <BR> Compares the specified object with this map for equality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#get(java.lang.Object)">get</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</CODE> <BR> Returns the value to which this map maps the specified key.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#keySet()">keySet</A></B>()</CODE> <BR> Returns a set view of the keys contained in this map.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#put(java.lang.Object, java.lang.Object)">put</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</CODE> <BR> Associates the specified value with the specified key in this map (optional operation).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#putAll(java.util.Map)">putAll</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A> map)</CODE> <BR> Copies all of the mappings from the specified map to this map (optional operation).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#remove(java.lang.Object)">remove</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</CODE> <BR> Removes the mapping for this key from this map if present (optional operation).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#toString()">toString</A></B>()</CODE> <BR> Converts the map to a string representation for debugging.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html#values()">values</A></B>()</CODE> <BR> Returns a collection view of the values contained in this map.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.bdb.collection.StoredContainer"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class com.sleepycat.bdb.collection.<A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#clear()">clear</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isAutoCommit()">isAutoCommit</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isDirtyReadAllowed()">isDirtyReadAllowed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isDirtyReadEnabled()">isDirtyReadEnabled</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isIndexed()">isIndexed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isOrdered()">isOrdered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isTransactional()">isTransactional</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isWriteAllowed()">isWriteAllowed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#size()">size</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html#clear()">clear</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html#isEmpty()">isEmpty</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html#size()">size</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="StoredMap(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, boolean)"><!-- --></A><H3> StoredMap</H3> <PRE> public <B>StoredMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a map view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>. <P> <DT><B>Parameters:</B><DD><CODE>store</CODE> - is the DataStore underlying the new collection.<DD><CODE>keyBinding</CODE> - is the binding used to translate between key buffers and key objects.<DD><CODE>valueBinding</CODE> - is the binding used to translate between value buffers and value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> <HR> <A NAME="StoredMap(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)"><!-- --></A><H3> StoredMap</H3> <PRE> public <B>StoredMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a map entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>. <P> <DT><B>Parameters:</B><DD><CODE>store</CODE> - is the DataStore underlying the new collection.<DD><CODE>keyBinding</CODE> - is the binding used to translate between key buffers and key objects.<DD><CODE>valueEntityBinding</CODE> - is the binding used to translate between key/value buffers and entity value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> <HR> <A NAME="StoredMap(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, boolean)"><!-- --></A><H3> StoredMap</H3> <PRE> public <B>StoredMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a map view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>. <P> <DT><B>Parameters:</B><DD><CODE>index</CODE> - is the DataIndex underlying the new collection.<DD><CODE>keyBinding</CODE> - is the binding used to translate between key buffers and key objects.<DD><CODE>valueBinding</CODE> - is the binding used to translate between value buffers and value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> <HR> <A NAME="StoredMap(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)"><!-- --></A><H3> StoredMap</H3> <PRE> public <B>StoredMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> keyBinding, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a map entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>. <P> <DT><B>Parameters:</B><DD><CODE>index</CODE> - is the DataIndex underlying the new collection.<DD><CODE>keyBinding</CODE> - is the binding used to translate between key buffers and key objects.<DD><CODE>valueEntityBinding</CODE> - is the binding used to translate between key/value buffers and entity value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="get(java.lang.Object)"><!-- --></A><H3> get</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> <B>get</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</PRE> <DL> <DD>Returns the value to which this map maps the specified key. If duplicates are allowed, this method returns the first duplicate, in the order in which duplicates are configured, that maps to the specified key. This method conforms to the <CODE>Map.get(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#get(java.lang.Object)">get</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="put(java.lang.Object, java.lang.Object)"><!-- --></A><H3> put</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> <B>put</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</PRE> <DL> <DD>Associates the specified value with the specified key in this map (optional operation). If duplicates are allowed and the specified key is already mapped to a value, this method appends the new duplicate after the existing duplicates. This method conforms to the <CODE>Map.put(java.lang.Object, java.lang.Object)</CODE> interface. <p>The key parameter may be null if an entity binding is used and the key will be derived from the value (entity) parameter. If an entity binding is used and the key parameter is non-null, then the key parameter must be equal to the key derived from the value parameter.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#put(java.lang.Object, java.lang.Object)">put</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the previous value associated with specified key, or null if there was no mapping for the key or if duplicates are allowed. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - if the collection is indexed, or if the collection is read-only. <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an entity value binding is used and the primary key of the value given is different than the existing stored primary key. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="append(java.lang.Object)"><!-- --></A><H3> append</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> <B>append</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</PRE> <DL> <DD>Appends a given value returning the newly assigned key. If a <A HREF="../../../../com/sleepycat/bdb/PrimaryKeyAssigner.html"><CODE>PrimaryKeyAssigner</CODE></A> is associated with Store for this map, it will be used to assigned the returned key. Otherwise the Store must be a QUEUE or RECNO database and the next available record number is assigned as the key. This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html"><CODE>Map</CODE></A> interface. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be appended. <DT><B>Returns:</B><DD>the assigned key. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - if the collection is indexed, or if the collection is read-only, or if the Store has no <A HREF="../../../../com/sleepycat/bdb/PrimaryKeyAssigner.html"><CODE>PrimaryKeyAssigner</CODE></A> and is not a QUEUE or RECNO database. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="remove(java.lang.Object)"><!-- --></A><H3> remove</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> <B>remove</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</PRE> <DL> <DD>Removes the mapping for this key from this map if present (optional operation). If duplicates are allowed, this method removes all duplicates for the given key. This method conforms to the <CODE>Map.remove(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - if the collection is read-only. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> containsKey</H3> <PRE> public boolean <B>containsKey</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</PRE> <DL> <DD>Returns true if this map contains the specified key. This method conforms to the <CODE>Map.containsKey(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#containsKey(java.lang.Object)">containsKey</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3> containsValue</H3> <PRE> public boolean <B>containsValue</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> value)</PRE> <DL> <DD>Returns true if this map contains the specified value. When an entity binding is used, this method returns whether the map contains the primary key and value mapping of the entity. This method conforms to the <CODE>Map.containsValue(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>containsValue</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#containsValue(java.lang.Object)">containsValue</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="putAll(java.util.Map)"><!-- --></A><H3> putAll</H3> <PRE> public void <B>putAll</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A> map)</PRE> <DL> <DD>Copies all of the mappings from the specified map to this map (optional operation). When duplicates are allowed, the mappings in the specified map are effectively appended to the existing mappings in this map, that is no previously existing mappings in this map are replaced. This method conforms to the <CODE>Map.putAll(java.util.Map)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>putAll</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - if the collection is read-only, or if the collection is indexed. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="keySet()"><!-- --></A><H3> keySet</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A> <B>keySet</B>()</PRE> <DL> <DD>Returns a set view of the keys contained in this map. A <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/SortedSet.html"><CODE>SortedSet</CODE></A> is returned if the map is ordered. The returned collection will be read-only if the map is read-only. This method conforms to the <CODE>Map.keySet()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a <A HREF="../../../../com/sleepycat/bdb/collection/StoredKeySet.html"><CODE>StoredKeySet</CODE></A> or a <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedKeySet.html"><CODE>StoredSortedKeySet</CODE></A> for this map. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isOrdered()"><CODE>StoredContainer.isOrdered()</CODE></A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> </DD> </DL> <HR> <A NAME="entrySet()"><!-- --></A><H3> entrySet</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A> <B>entrySet</B>()</PRE> <DL> <DD>Returns a set view of the mappings contained in this map. A <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/SortedSet.html"><CODE>SortedSet</CODE></A> is returned if the map is ordered. The returned collection will be read-only if the map is read-only. This method conforms to the <CODE>Map.entrySet()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a <A HREF="../../../../com/sleepycat/bdb/collection/StoredEntrySet.html"><CODE>StoredEntrySet</CODE></A> or a <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedEntrySet.html"><CODE>StoredSortedEntrySet</CODE></A> for this map. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isOrdered()"><CODE>StoredContainer.isOrdered()</CODE></A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> </DD> </DL> <HR> <A NAME="values()"><!-- --></A><H3> values</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html">Collection</A> <B>values</B>()</PRE> <DL> <DD>Returns a collection view of the values contained in this map. A <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/SortedSet.html"><CODE>SortedSet</CODE></A> is returned if the map is ordered and the value/entity binding can be used to derive the map's key from its value/entity object. The returned collection will be read-only if the map is read-only. This method conforms to the <CODE>Map.entrySet()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a <A HREF="../../../../com/sleepycat/bdb/collection/StoredEntrySet.html"><CODE>StoredEntrySet</CODE></A> or a <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedEntrySet.html"><CODE>StoredSortedEntrySet</CODE></A> for this map. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isOrdered()"><CODE>StoredContainer.isOrdered()</CODE></A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isWriteAllowed()"><CODE>StoredContainer.isWriteAllowed()</CODE></A></DL> </DD> </DL> <HR> <A NAME="duplicates(java.lang.Object)"><!-- --></A><H3> duplicates</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html">Collection</A> <B>duplicates</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> key)</PRE> <DL> <DD>Returns a new collection containing the values mapped to the given key in this map. This collection's iterator() method is particularly useful for iterating over the duplicates for a given key, since this is not supported by the standard Map interface. This method does not exist in the standard <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html"><CODE>Map</CODE></A> interface. <p>If no mapping for the given key is present, an empty collection is returned. If duplicates are not allowed, at most a single value will be in the collection returned. If duplicates are allowed, the returned collection's add() method may be used to add values for the given key.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>key</CODE> - is the key for which values are to be returned. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="equals(java.lang.Object)"><!-- --></A><H3> equals</H3> <PRE> public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> other)</PRE> <DL> <DD>Compares the specified object with this map for equality. A value comparison is performed by this method and the stored values are compared rather than calling the equals() method of each element. This method conforms to the <CODE>Map.equals(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>equals</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">Map</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE> <DL> <DD>Converts the map to a string representation for debugging. WARNING: All mappings will be converted to strings and returned and therefore the returned string may be very large. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the string representation. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoredMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/collection/StoredList.html"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedEntrySet.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="StoredMap.html" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <font size=1><a href="../../../../../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </BODY> </HTML>