<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_75) on Fri May 13 13:32:18 PDT 2016 -->
<title>StoredMap (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StoredMap (Oracle - Berkeley DB Java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoredMap.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/collections/StoredList.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/collections/StoredMap.html" target="_top">Frames</a></li>
<li><a href="StoredMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.collections</div>
<h2 title="Class StoredMap" class="title">Class StoredMap<K,V></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredContainer</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.StoredMap<K,V></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable, java.util.concurrent.ConcurrentMap<K,V>, java.util.Map<K,V></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections">StoredSortedMap</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StoredMap<K,V></span>
extends <a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a>
implements java.util.concurrent.ConcurrentMap<K,V></pre>
<div class="block">A Map view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</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/collections/StoredMap.html#duplicates(K)"><code>duplicates(K)</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredMap.html#duplicatesMap(K,%20com.sleepycat.bind.EntryBinding)"><code>duplicatesMap(K, com.sleepycat.bind.EntryBinding)</code></a></li>
<li><a href="../../../com/sleepycat/collections/StoredMap.html#append(V)"><code>append(V)</code></a></li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.Map">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface java.util.Map</h3>
<code>java.util.Map.Entry<K,V></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap(com.sleepycat.db.Database,%20com.sleepycat.bind.EntryBinding,%20com.sleepycat.bind.EntityBinding,%20boolean)">StoredMap</a></strong>(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueEntityBinding,
boolean writeAllowed)</code>
<div class="block">Creates a map entity view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap(com.sleepycat.db.Database,%20com.sleepycat.bind.EntryBinding,%20com.sleepycat.bind.EntityBinding,%20com.sleepycat.collections.PrimaryKeyAssigner)">StoredMap</a></strong>(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueEntityBinding,
<a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections">PrimaryKeyAssigner</a> keyAssigner)</code>
<div class="block">Creates a map entity view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> with a <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><code>PrimaryKeyAssigner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap(com.sleepycat.db.Database,%20com.sleepycat.bind.EntryBinding,%20com.sleepycat.bind.EntryBinding,%20boolean)">StoredMap</a></strong>(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueBinding,
boolean writeAllowed)</code>
<div class="block">Creates a map view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap(com.sleepycat.db.Database,%20com.sleepycat.bind.EntryBinding,%20com.sleepycat.bind.EntryBinding,%20com.sleepycat.collections.PrimaryKeyAssigner)">StoredMap</a></strong>(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueBinding,
<a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections">PrimaryKeyAssigner</a> keyAssigner)</code>
<div class="block">Creates a map view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> with a <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><code>PrimaryKeyAssigner</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#append(V)">append</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</code>
<div class="block">Appends a given value returning the newly assigned key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object key)</code>
<div class="block">Returns true if this map contains the specified key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#containsValue(java.lang.Object)">containsValue</a></strong>(java.lang.Object value)</code>
<div class="block">Returns true if this map contains the specified value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#duplicates(K)">duplicates</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key)</code>
<div class="block">Returns a new collection containing the values mapped to the given key
in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><PK> java.util.Map<PK,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#duplicatesMap(K,%20com.sleepycat.bind.EntryBinding)">duplicatesMap</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> secondaryKey,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a> primaryKeyBinding)</code>
<div class="block">Returns a new map from primary key to value for the subset of records
having a given secondary key (duplicates).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#entrySet()">entrySet</a></strong>()</code>
<div class="block">Returns a set view of the mappings contained in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code>
<div class="block">Compares the specified object with this map for equality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#get(java.lang.Object)">get</a></strong>(java.lang.Object key)</code>
<div class="block">Returns the value to which this map maps the specified key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#keySet()">keySet</a></strong>()</code>
<div class="block">Returns a set view of the keys contained in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#put(K,%20V)">put</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</code>
<div class="block">Associates the specified value with the specified key in this map
(optional operation).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#putAll(java.util.Map)">putAll</a></strong>(java.util.Map<? extends <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,? extends <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> map)</code>
<div class="block">Copies all of the mappings from the specified map to this map (optional
operation).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#putIfAbsent(K,%20V)">putIfAbsent</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</code>
<div class="block">If the specified key is not already associated with a value, associate
it with the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object key)</code>
<div class="block">Removes the mapping for this key from this map if present (optional
operation).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#remove(java.lang.Object,%20java.lang.Object)">remove</a></strong>(java.lang.Object key,
java.lang.Object value)</code>
<div class="block">Remove entry for key only if currently mapped to given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#replace(K,%20V)">replace</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</code>
<div class="block">Replace entry for key only if currently mapped to some value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#replace(K,%20V,%20V)">replace</a></strong>(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> oldValue,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> newValue)</code>
<div class="block">Replace entry for key only if currently mapped to given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#size()">size</a></strong>()</code>
<div class="block">Returns a non-transactional count of the records in the collection or
map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#toString()">toString</a></strong>()</code>
<div class="block">Converts the map to a string representation for debugging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredMap.html#values()">values</a></strong>()</code>
<div class="block">Returns a collection view of the values contained in this map.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.collections.StoredContainer">
<!-- -->
</a>
<h3>Methods inherited from class com.sleepycat.collections.<a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a></h3>
<code><a href="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()">areKeyRangesAllowed</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#clear()">clear</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#getCursorConfig()">getCursorConfig</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isEmpty()">isEmpty</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isOrdered()">isOrdered</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isSecondary()">isSecondary</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isTransactional()">isTransactional</a>, <a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()">isWriteAllowed</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Map">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Map</h3>
<code>clear, isEmpty</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StoredMap(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, com.sleepycat.bind.EntryBinding, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StoredMap</h4>
<pre>public StoredMap(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueBinding,
boolean writeAllowed)</pre>
<div class="block">Creates a map view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - is the Database underlying the new collection.</dd><dd><code>keyBinding</code> - is the binding used to translate between key buffers
and key objects.</dd><dd><code>valueBinding</code> - is the binding used to translate between value
buffers and value objects.</dd><dd><code>writeAllowed</code> - is true to create a read-write collection or false
to create a read-only collection.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if formats are not consistently
defined or a parameter is invalid.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="StoredMap(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, com.sleepycat.bind.EntryBinding, com.sleepycat.collections.PrimaryKeyAssigner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StoredMap</h4>
<pre>public StoredMap(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueBinding,
<a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections">PrimaryKeyAssigner</a> keyAssigner)</pre>
<div class="block">Creates a map view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> with a <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><code>PrimaryKeyAssigner</code></a>. Writing is allowed for the created map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - is the Database underlying the new collection.</dd><dd><code>keyBinding</code> - is the binding used to translate between key buffers
and key objects.</dd><dd><code>valueBinding</code> - is the binding used to translate between value
buffers and value objects.</dd><dd><code>keyAssigner</code> - is used by the <a href="../../../com/sleepycat/collections/StoredMap.html#append(V)"><code>append(V)</code></a> method to assign
primary keys.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if formats are not consistently
defined or a parameter is invalid.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="StoredMap(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, com.sleepycat.bind.EntityBinding, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StoredMap</h4>
<pre>public StoredMap(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueEntityBinding,
boolean writeAllowed)</pre>
<div class="block">Creates a map entity view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - is the Database underlying the new collection.</dd><dd><code>keyBinding</code> - is the binding used to translate between key buffers
and key objects.</dd><dd><code>valueEntityBinding</code> - is the binding used to translate between
key/value buffers and entity value objects.</dd><dd><code>writeAllowed</code> - is true to create a read-write collection or false
to create a read-only collection.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if formats are not consistently
defined or a parameter is invalid.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="StoredMap(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, com.sleepycat.bind.EntityBinding, com.sleepycat.collections.PrimaryKeyAssigner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StoredMap</h4>
<pre>public StoredMap(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> database,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keyBinding,
<a href="../../../com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</a><<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> valueEntityBinding,
<a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections">PrimaryKeyAssigner</a> keyAssigner)</pre>
<div class="block">Creates a map entity view of a <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> with a <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><code>PrimaryKeyAssigner</code></a>. Writing is allowed for the created map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - is the Database underlying the new collection.</dd><dd><code>keyBinding</code> - is the binding used to translate between key buffers
and key objects.</dd><dd><code>valueEntityBinding</code> - is the binding used to translate between
key/value buffers and entity value objects.</dd><dd><code>keyAssigner</code> - is used by the <a href="../../../com/sleepycat/collections/StoredMap.html#append(V)"><code>append(V)</code></a> method to assign
primary keys.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if formats are not consistently
defined or a parameter is invalid.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="get(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> get(java.lang.Object key)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>get</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="put(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="put(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> put(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</pre>
<div class="block">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(K, V)</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></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>put</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the previous value associated with specified key, or null if
there was no mapping for the key or if duplicates are allowed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is indexed, or
if the collection is read-only.</dd>
<dd><code>java.lang.IllegalArgumentException</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>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="append(java.lang.Object)">
<!-- -->
</a><a name="append(V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> append(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</pre>
<div class="block">Appends a given value returning the newly assigned key. If a <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><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 <code>Map</code>
interface.
<p>Note that for the JE product, QUEUE and RECNO databases are not
supported, and therefore a PrimaryKeyAssigner must be associated with
the map in order to call this method.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to be appended.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the assigned key.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is indexed, or
if the collection is read-only, or if the Store has no <a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><code>PrimaryKeyAssigner</code></a> and is not a QUEUE or RECNO database.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> remove(java.lang.Object key)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is read-only.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="putIfAbsent(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="putIfAbsent(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putIfAbsent</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> putIfAbsent(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</pre>
<div class="block">If the specified key is not already associated with a value, associate
it with the given value. This method conforms to the <code>ConcurrentMap.putIfAbsent(K, V)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>putIfAbsent</code> in interface <code>java.util.concurrent.ConcurrentMap<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public boolean remove(java.lang.Object key,
java.lang.Object value)</pre>
<div class="block">Remove entry for key only if currently mapped to given value. This
method conforms to the <code>ConcurrentMap.remove(Object,Object)</code>
interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.concurrent.ConcurrentMap<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="replace(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="replace(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>public <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> replace(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> value)</pre>
<div class="block">Replace entry for key only if currently mapped to some value. This
method conforms to the <code>ConcurrentMap.replace(Object,Object)</code>
interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>replace</code> in interface <code>java.util.concurrent.ConcurrentMap<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="replace(java.lang.Object,java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="replace(K, V, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>public boolean replace(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> oldValue,
<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a> newValue)</pre>
<div class="block">Replace entry for key only if currently mapped to given value. This
method conforms to the <code>ConcurrentMap.replace(Object,Object,Object)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>replace</code> in interface <code>java.util.concurrent.ConcurrentMap<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="containsKey(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>public boolean containsKey(java.lang.Object key)</pre>
<div class="block">Returns true if this map contains the specified key. This method
conforms to the <code>Map.containsKey(java.lang.Object)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsKey</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="containsValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsValue</h4>
<pre>public boolean containsValue(java.lang.Object value)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsValue</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="putAll(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre>public void putAll(java.util.Map<? extends <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,? extends <a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> map)</pre>
<div class="block">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<? extends K, ? extends V>)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>putAll</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is read-only, or
if the collection is indexed.</dd>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="keySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre>public java.util.Set<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>> keySet()</pre>
<div class="block">Returns a set view of the keys contained in this map. A <code>SortedSet</code> is returned if the map supports key ranges. The
returned collection will be read-only if the map is read-only. This
method conforms to the <code>Map.keySet()</code> interface.
<p>Note that the return value is a StoredCollection and must be treated
as such; for example, its iterators must be explicitly closed.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>keySet</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><code>StoredKeySet</code></a> or a <a href="../../../com/sleepycat/collections/StoredSortedKeySet.html" title="class in com.sleepycat.collections"><code>StoredSortedKeySet</code></a> for this
map.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()"><code>StoredContainer.areKeyRangesAllowed()</code></a>,
<a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><code>StoredContainer.isWriteAllowed()</code></a></dd></dl>
</li>
</ul>
<a name="entrySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entrySet</h4>
<pre>public java.util.Set<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>>> entrySet()</pre>
<div class="block">Returns a set view of the mappings contained in this map. A <code>SortedSet</code> is returned if the map supports key ranges. The
returned collection will be read-only if the map is read-only. This
method conforms to the <code>Map.entrySet()</code> interface.
<p>Note that the return value is a StoredCollection and must be treated
as such; for example, its iterators must be explicitly closed.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>entrySet</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="class in com.sleepycat.collections"><code>StoredEntrySet</code></a> or a <a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><code>StoredSortedEntrySet</code></a> for
this map.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()"><code>StoredContainer.areKeyRangesAllowed()</code></a>,
<a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><code>StoredContainer.isWriteAllowed()</code></a></dd></dl>
</li>
</ul>
<a name="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public java.util.Collection<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> values()</pre>
<div class="block">Returns a collection view of the values contained in this map. A <code>SortedSet</code> is returned if the map supports key ranges 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.values()</code>
interface.
<p>Note that the return value is a StoredCollection and must be treated
as such; for example, its iterators must be explicitly closed.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>values</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../com/sleepycat/collections/StoredValueSet.html" title="class in com.sleepycat.collections"><code>StoredValueSet</code></a> or a <a href="../../../com/sleepycat/collections/StoredSortedValueSet.html" title="class in com.sleepycat.collections"><code>StoredSortedValueSet</code></a> for
this map.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()"><code>StoredContainer.areKeyRangesAllowed()</code></a>,
<a href="../../../com/sleepycat/collections/StoredContainer.html#isWriteAllowed()"><code>StoredContainer.isWriteAllowed()</code></a></dd></dl>
</li>
</ul>
<a name="duplicates(java.lang.Object)">
<!-- -->
</a><a name="duplicates(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>duplicates</h4>
<pre>public java.util.Collection<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> duplicates(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> key)</pre>
<div class="block">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 <code>Map</code> 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></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - is the key for which values are to be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="duplicatesMap(java.lang.Object,com.sleepycat.bind.EntryBinding)">
<!-- -->
</a><a name="duplicatesMap(K, com.sleepycat.bind.EntryBinding)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>duplicatesMap</h4>
<pre>public <PK> java.util.Map<PK,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>> duplicatesMap(<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a> secondaryKey,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a> primaryKeyBinding)</pre>
<div class="block">Returns a new map from primary key to value for the subset of records
having a given secondary key (duplicates). This method does not exist
in the standard <code>Map</code> 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></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>secondaryKey</code> - is the secondary key for which duplicates values
will be represented by the returned map.</dd><dd><code>primaryKeyBinding</code> - is the binding used for keys in the returned
map.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object other)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>equals</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hashCode</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../com/sleepycat/collections/StoredContainer.html#size()">StoredContainer</a></code></strong></div>
<div class="block">Returns a non-transactional count of the records in the collection or
map. This method conforms to the <code>Collection.size()</code> and
<code>Map.size()</code> interfaces.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Map<<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">K</a>,<a href="../../../com/sleepycat/collections/StoredMap.html" title="type parameter in StoredMap">V</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/collections/StoredContainer.html#size()">size</a></code> in class <code><a href="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util">RuntimeExceptionWrapper</a></code> - if a checked exception is thrown,
including a <code>DatabaseException</code> on BDB (C edition).</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoredMap.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/collections/StoredList.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/collections/StoredMap.html" target="_top">Frames</a></li>
<li><a href="StoredMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
