<!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>MapEntryParameter (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="MapEntryParameter (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/MapEntryParameter.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/CurrentTransaction.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/sleepycat/collections/MapEntryParameter.html" target="_top">Frames</a></li> <li><a href="MapEntryParameter.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 MapEntryParameter" class="title">Class MapEntryParameter<K,V></h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.sleepycat.collections.MapEntryParameter<K,V></li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.util.Map.Entry<K,V></dd> </dl> <hr> <br> <pre>public class <span class="strong">MapEntryParameter<K,V></span> extends java.lang.Object implements java.util.Map.Entry<K,V></pre> <div class="block">A simple <code>Map.Entry</code> implementation that can be used as in input parameter. Since a <code>MapEntryParameter</code> is not obtained from a map, it is not attached to any map in particular. To emphasize that changing this object does not change the map, the <a href="../../../com/sleepycat/collections/MapEntryParameter.html#setValue(V)"><code>setValue(V)</code></a> method always throws <code>UnsupportedOperationException</code>. <p><b>Warning:</b> Use of this interface violates the Java Collections interface contract since these state that <code>Map.Entry</code> objects should only be obtained from <code>Map.entrySet()</code> sets, while this class allows constructing them directly. However, it is useful for performing operations on an entry set such as add(), contains(), etc. For restrictions see <a href="../../../com/sleepycat/collections/MapEntryParameter.html#getValue()"><code>getValue()</code></a> and <a href="../../../com/sleepycat/collections/MapEntryParameter.html#setValue(V)"><code>setValue(V)</code></a>.</p></div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#MapEntryParameter(K,%20V)">MapEntryParameter</a></strong>(<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a> key, <a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> value)</code> <div class="block">Creates a map entry with a given key and value.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> <div class="block">Compares this entry to a given entry as specified by <code>Map.Entry.equals(java.lang.Object)</code>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#getKey()">getKey</a></strong>()</code> <div class="block">Returns the key of this entry.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#getValue()">getValue</a></strong>()</code> <div class="block">Returns the value of this entry.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#hashCode()">hashCode</a></strong>()</code> <div class="block">Computes a hash code as specified by <code>Map.Entry.hashCode()</code>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/MapEntryParameter.html#setValue(V)">setValue</a></strong>(<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> newValue)</code> <div class="block">Always throws <code>UnsupportedOperationException</code> since this object is not attached to a map.</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/MapEntryParameter.html#toString()">toString</a></strong>()</code> <div class="block">Converts the entry to a string representation for debugging.</div> </td> </tr> </table> <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> </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="MapEntryParameter(java.lang.Object,java.lang.Object)"> <!-- --> </a><a name="MapEntryParameter(K, V)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>MapEntryParameter</h4> <pre>public MapEntryParameter(<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a> key, <a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> value)</pre> <div class="block">Creates a map entry with a given key and value.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - is the key to use.</dd><dd><code>value</code> - is the value to use.</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="hashCode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <div class="block">Computes a hash code as specified by <code>Map.Entry.hashCode()</code>.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>hashCode</code> in interface <code>java.util.Map.Entry<<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a>,<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a>></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> <dt><span class="strong">Returns:</span></dt><dd>the computed hash code.</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 this entry to a given entry as specified by <code>Map.Entry.equals(java.lang.Object)</code>.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>equals</code> in interface <code>java.util.Map.Entry<<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a>,<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a>></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> <dt><span class="strong">Returns:</span></dt><dd>the computed hash code.</dd></dl> </li> </ul> <a name="getKey()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getKey</h4> <pre>public final <a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a> getKey()</pre> <div class="block">Returns the key of this entry.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getKey</code> in interface <code>java.util.Map.Entry<<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a>,<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a>></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the key of this entry.</dd></dl> </li> </ul> <a name="getValue()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValue</h4> <pre>public final <a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> getValue()</pre> <div class="block">Returns the value of this entry. Note that this will be the value passed to the constructor or the last value passed to <a href="../../../com/sleepycat/collections/MapEntryParameter.html#setValue(V)"><code>setValue(V)</code></a>. It will not reflect changes made to a Map.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getValue</code> in interface <code>java.util.Map.Entry<<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a>,<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a>></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the value of this entry.</dd></dl> </li> </ul> <a name="setValue(java.lang.Object)"> <!-- --> </a><a name="setValue(V)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setValue</h4> <pre>public <a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> setValue(<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a> newValue)</pre> <div class="block">Always throws <code>UnsupportedOperationException</code> since this object is not attached to a map.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>setValue</code> in interface <code>java.util.Map.Entry<<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">K</a>,<a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="type parameter in MapEntryParameter">V</a>></code></dd> </dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <div class="block">Converts the entry to a string representation for debugging.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> <dt><span class="strong">Returns:</span></dt><dd>the string representation.</dd></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/MapEntryParameter.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/CurrentTransaction.html" title="class in com.sleepycat.collections"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/collections/PrimaryKeyAssigner.html" title="interface in com.sleepycat.collections"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/sleepycat/collections/MapEntryParameter.html" target="_top">Frames</a></li> <li><a href="MapEntryParameter.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p> </body> </html>