mirror of
https://github.com/berkeleydb/je.git
synced 2024-11-15 09:46:25 +00:00
1191 lines
74 KiB
HTML
1191 lines
74 KiB
HTML
|
<!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 (1.8.0_151) on Tue Oct 31 17:36:45 EDT 2017 -->
|
||
|
<title>StoredMap (Oracle - Berkeley DB Java Edition API)</title>
|
||
|
<meta name="date" content="2017-10-31">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
|
||
|
<script type="text/javascript" src="../../../script.js"></script>
|
||
|
</head>
|
||
|
<body>
|
||
|
<script type="text/javascript"><!--
|
||
|
try {
|
||
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
parent.document.title="StoredMap (Oracle - Berkeley DB Java Edition API)";
|
||
|
}
|
||
|
}
|
||
|
catch(err) {
|
||
|
}
|
||
|
//-->
|
||
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
|
||
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
||
|
var altColor = "altColor";
|
||
|
var rowColor = "rowColor";
|
||
|
var tableTab = "tableTab";
|
||
|
var activeTableTab = "activeTableTab";
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="topNav"><a name="navbar.top">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">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="typeNameLabel">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/je/Database.html" title="class in com.sleepycat.je"><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-com.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>
|
||
|
<dl>
|
||
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
||
|
<dd>Mark Hayes</dd>
|
||
|
</dl>
|
||
|
</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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap-com.sleepycat.je.Database-com.sleepycat.bind.EntryBinding-com.sleepycat.bind.EntityBinding-boolean-">StoredMap</a></span>(<a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap-com.sleepycat.je.Database-com.sleepycat.bind.EntryBinding-com.sleepycat.bind.EntityBinding-com.sleepycat.collections.PrimaryKeyAssigner-">StoredMap</a></span>(<a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap-com.sleepycat.je.Database-com.sleepycat.bind.EntryBinding-com.sleepycat.bind.EntryBinding-boolean-">StoredMap</a></span>(<a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#StoredMap-com.sleepycat.je.Database-com.sleepycat.bind.EntryBinding-com.sleepycat.bind.EntryBinding-com.sleepycat.collections.PrimaryKeyAssigner-">StoredMap</a></span>(<a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
</tr>
|
||
|
<tr id="i0" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#append-V-">append</a></span>(<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 id="i1" class="rowColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#containsKey-java.lang.Object-">containsKey</a></span>(java.lang.Object key)</code>
|
||
|
<div class="block">Returns true if this map contains the specified key.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i2" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#containsValue-java.lang.Object-">containsValue</a></span>(java.lang.Object value)</code>
|
||
|
<div class="block">Returns true if this map contains the specified value.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i3" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#duplicates-K-">duplicates</a></span>(<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 id="i4" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#duplicatesMap-K-com.sleepycat.bind.EntryBinding-">duplicatesMap</a></span>(<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 id="i5" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#entrySet--">entrySet</a></span>()</code>
|
||
|
<div class="block">Returns a set view of the mappings contained in this map.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i6" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code>
|
||
|
<div class="block">Compares the specified object with this map for equality.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i7" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#get-java.lang.Object-">get</a></span>(java.lang.Object key)</code>
|
||
|
<div class="block">Returns the value to which this map maps the specified key.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i8" class="altColor">
|
||
|
<td class="colFirst"><code>int</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#hashCode--">hashCode</a></span>()</code> </td>
|
||
|
</tr>
|
||
|
<tr id="i9" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#keySet--">keySet</a></span>()</code>
|
||
|
<div class="block">Returns a set view of the keys contained in this map.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i10" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#put-K-V-">put</a></span>(<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 id="i11" class="rowColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#putAll-java.util.Map-">putAll</a></span>(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 id="i12" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#putIfAbsent-K-V-">putIfAbsent</a></span>(<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 id="i13" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#remove-java.lang.Object-">remove</a></span>(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 id="i14" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#remove-java.lang.Object-java.lang.Object-">remove</a></span>(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 id="i15" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#replace-K-V-">replace</a></span>(<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 id="i16" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#replace-K-V-V-">replace</a></span>(<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 id="i17" class="rowColor">
|
||
|
<td class="colFirst"><code>int</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#size--">size</a></span>()</code>
|
||
|
<div class="block">Returns a non-transactional count of the records in the collection or
|
||
|
map.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i18" class="altColor">
|
||
|
<td class="colFirst"><code>java.lang.String</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#toString--">toString</a></span>()</code>
|
||
|
<div class="block">Converts the map to a string representation for debugging.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i19" 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><span class="memberNameLink"><a href="../../../com/sleepycat/collections/StoredMap.html#values--">values</a></span>()</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.concurrent.ConcurrentMap">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from interface java.util.concurrent.ConcurrentMap</h3>
|
||
|
<code>compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll</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.je.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/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">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="throwsLabel">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.je.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/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><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="paramLabel">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="throwsLabel">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.je.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/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">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="throwsLabel">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.je.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/je/Database.html" title="class in com.sleepycat.je">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/je/Database.html" title="class in com.sleepycat.je"><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="paramLabel">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="throwsLabel">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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">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.
|
||
|
|
||
|
<!-- begin JE only --></dd>
|
||
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE only --></dd>
|
||
|
<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="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>value</code> - the value to be appended.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the assigned key.
|
||
|
|
||
|
<!-- begin JE only --></dd>
|
||
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE only --></dd>
|
||
|
<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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE only --></dd>
|
||
|
<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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
<dd><code>putIfAbsent</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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
<dd><code>replace</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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
<dd><code>replace</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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
Operation Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE only --></dd>
|
||
|
<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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">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="throwsLabel">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="seeLabel">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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">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="throwsLabel">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="seeLabel">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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">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="throwsLabel">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="seeLabel">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="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>key</code> - is the key for which values are to be returned.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the new collection.</dd>
|
||
|
<dt><span class="throwsLabel">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="paramLabel">Type Parameters:</span></dt>
|
||
|
<dd><code>PK</code> - the primary key class.</dd>
|
||
|
<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
|
||
|
<dd>the new map.</dd>
|
||
|
<dt><span class="throwsLabel">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.
|
||
|
|
||
|
<!-- begin JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
|
||
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
Failures</a> occurs.</dd>
|
||
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
environment-wide failure occurs.
|
||
|
<!-- end JE 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="hashCode--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>hashCode</h4>
|
||
|
<pre>public int hashCode()</pre>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../com/sleepycat/collections/StoredContainer.html#size--">StoredContainer</a></code></span></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.
|
||
|
|
||
|
<!-- begin JE only -->
|
||
|
<p>This operation is faster than obtaining a count by scanning the
|
||
|
collection manually, and will not perturb the current contents of the
|
||
|
cache. However, the count is not guaranteed to be accurate if there are
|
||
|
concurrent updates.</p>
|
||
|
<!-- end JE only --></div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Specified by:</span></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>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the number of records.
|
||
|
|
||
|
<!-- begin JE only --></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the string representation.</dd>
|
||
|
<dt><span class="throwsLabel">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>
|
||
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><span class="typeNameLink">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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
</body>
|
||
|
</html>
|