<!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:17 PDT 2016 -->
<title>StoredEntrySet (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="StoredEntrySet (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/StoredEntrySet.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/StoredContainer.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredIterator.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/StoredEntrySet.html" target="_top">Frames</a></li>
<li><a href="StoredEntrySet.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><a href="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 StoredEntrySet" class="title">Class StoredEntrySet<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><a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredCollection</a><java.util.Map.Entry<K,V>></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.StoredEntrySet<K,V></li>
</ul>
</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.lang.Iterable<java.util.Map.Entry<K,V>>, java.util.Collection<java.util.Map.Entry<K,V>>, java.util.Set<java.util.Map.Entry<K,V>></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/sleepycat/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections">StoredSortedEntrySet</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StoredEntrySet<K,V></span>
extends <a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a><java.util.Map.Entry<K,V>>
implements java.util.Set<java.util.Map.Entry<K,V>></pre>
<div class="block">The Set returned by Map.entrySet(). This class may not be instantiated
directly. Contrary to what is stated by <code>Map.entrySet()</code> this class
does support the <a href="../../../com/sleepycat/collections/StoredEntrySet.html#add(java.util.Map.Entry)"><code>add(java.util.Map.Entry<K, V>)</code></a> and <a href="../../../com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)"><code>StoredCollection.addAll(java.util.Collection<? extends E>)</code></a> methods.
<p>The <code>Map.Entry.setValue(V)</code> method of the Map.Entry objects
that are returned by this class and its iterators behaves just as the <a href="../../../com/sleepycat/collections/StoredIterator.html#set(E)"><code>StoredIterator.set(E)</code></a> method does.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_com.sleepycat.collections.StoredCollection">
<!-- -->
</a>
<h3>Fields inherited from class com.sleepycat.collections.<a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a></h3>
<code><a href="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</a></code></li>
</ul>
</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredEntrySet.html#add(java.util.Map.Entry)">add</a></strong>(java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>> mapEntry)</code>
<div class="block">Adds the specified element to this set if it is not already present
(optional operation).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredEntrySet.html#contains(java.lang.Object)">contains</a></strong>(java.lang.Object mapEntry)</code>
<div class="block">Returns true if this set contains the specified element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredEntrySet.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object mapEntry)</code>
<div class="block">Removes the specified element from this set if it is present (optional
operation).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/StoredEntrySet.html#toString()">toString</a></strong>()</code>
<div class="block">Converts the collection to a string representation for debugging.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.collections.StoredCollection">
<!-- -->
</a>
<h3>Methods inherited from class com.sleepycat.collections.<a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a></h3>
<code><a href="../../../com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)">addAll</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#containsAll(java.util.Collection)">containsAll</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#equals(java.lang.Object)">equals</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()">getIteratorBlockSize</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#hashCode()">hashCode</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator()">iterator</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#iterator(boolean)">iterator</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#join(com.sleepycat.collections.StoredContainer[],%20java.lang.Object[],%20com.sleepycat.db.JoinConfig)">join</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#removeAll(java.util.Collection)">removeAll</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#retainAll(java.util.Collection)">retainAll</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)">setIteratorBlockSize</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#size()">size</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator()">storedIterator</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)">storedIterator</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#toArray()">toArray</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#toArray(T[])">toArray</a>, <a href="../../../com/sleepycat/collections/StoredCollection.html#toList()">toList</a></code></li>
</ul>
<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.Set">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Set</h3>
<code>addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add(java.util.Map.Entry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public boolean add(java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>> mapEntry)</pre>
<div class="block">Adds the specified element to this set if it is not already present
(optional operation).
This method conforms to the <code>Set.add(E)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>add</code> in interface <code>java.util.Collection<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>add</code> in interface <code>java.util.Set<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>mapEntry</code> - must be a <code>Map.Entry</code> instance.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the key-value pair was added to the set (and was not
previously present).</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the collection is read-only.</dd>
<dd><code>java.lang.ClassCastException</code> - if the mapEntry is not a <code>Map.Entry</code> instance.</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 boolean remove(java.lang.Object mapEntry)</pre>
<div class="block">Removes the specified element from this set if it is present (optional
operation).
This method conforms to the <code>Set.remove(java.lang.Object)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Collection<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Set<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>mapEntry</code> - is a <code>Map.Entry</code> instance to be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the key-value pair was removed from the set, or false if
the mapEntry is not a <code>Map.Entry</code> instance or is not
present in the set.</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="contains(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(java.lang.Object mapEntry)</pre>
<div class="block">Returns true if this set contains the specified element.
This method conforms to the <code>Set.contains(java.lang.Object)</code> interface.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>contains</code> in interface <code>java.util.Collection<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>contains</code> in interface <code>java.util.Set<java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>mapEntry</code> - is a <code>Map.Entry</code> instance to be checked.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the key-value pair is present in the set, or false if
the mapEntry is not a <code>Map.Entry</code> instance or is not
present in the set.</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="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../com/sleepycat/collections/StoredCollection.html#toString()">StoredCollection</a></code></strong></div>
<div class="block">Converts the collection to a string representation for debugging.
WARNING: The returned string may be very large.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../com/sleepycat/collections/StoredCollection.html#toString()">toString</a></code> in class <code><a href="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</a><java.util.Map.Entry<<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">K</a>,<a href="../../../com/sleepycat/collections/StoredEntrySet.html" title="type parameter in StoredEntrySet">V</a>>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation.</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/StoredEntrySet.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/StoredContainer.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/collections/StoredIterator.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/StoredEntrySet.html" target="_top">Frames</a></li>
<li><a href="StoredEntrySet.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><a href="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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>
