| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>WeakValueHashMap (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.util.collection, class: WeakValueHashMap"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.collection.WeakValueHashMap class"> |
| <meta name="keywords" content="size()"> |
| <meta name="keywords" content="containsKey()"> |
| <meta name="keywords" content="containsValue()"> |
| <meta name="keywords" content="get()"> |
| <meta name="keywords" content="put()"> |
| <meta name="keywords" content="putIfAbsent()"> |
| <meta name="keywords" content="replace()"> |
| <meta name="keywords" content="remove()"> |
| <meta name="keywords" content="clear()"> |
| <meta name="keywords" content="entrySet()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/WeakValueHashMap.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util.collection</a></div> |
| <h1 title="Class WeakValueHashMap" class="title">Class WeakValueHashMap<K,<wbr>V></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><K,<wbr>V> |
| <div class="inheritance">WeakValueHashMap<K,<wbr>V></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - the class of key elements.</dd> |
| <dd><code>V</code> - the class of value elements.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><K,<wbr>V></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">WeakValueHashMap<K,<wbr>V></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><K,<wbr>V></span></div> |
| <div class="block">A hashtable-based map implementation that uses <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ref/WeakReference.html" title="class or interface in java.lang.ref" class="external-link">weak references</a>, |
| leaving memory when an entry is not used anymore. An entry in a <code>WeakValueHashMap</code> |
| will automatically be removed when its value is no longer in ordinary use. This class is |
| similar to the standard <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/WeakHashMap.html" title="class or interface in java.util" class="external-link"><code>WeakHashMap</code></a> class, except that weak references |
| apply to values rather than keys. |
| |
| <p>Note that this class is <strong>not</strong> a cache, because the entries are discarded |
| as soon as the garbage collector determines that they are no longer in use. If caching |
| service are wanted, or if concurrency are wanted, consider using <a href="Cache.html" title="class in org.apache.sis.util.collection"><code>Cache</code></a> instead.</p> |
| |
| <p>This class is convenient for avoiding the creation of duplicated elements, as in the |
| example below:</p> |
| |
| <blockquote><pre>K key = ... |
| V value; |
| <font color="green">synchronized</font> (map) { |
| value = map.<b>get</b>(key); |
| <font color="green">if</font> (value == <font color="green">null</font>) { |
| value = ...; <i><font color="gray">// Create the value here.</font></i> |
| map.<b>put</b>(key, value); |
| } |
| }</pre></blockquote> |
| |
| In the above example, the calculation of a new value needs to be fast because it is performed inside a synchronized |
| statement blocking all other access to the map. This is okay if that particular <code>WeakValueHashMap</code> instance |
| is not expected to be used in a highly concurrent environment. |
| |
| <p><code>WeakValueHashMap</code> works with array keys as one would expect. For example, arrays of <code>int[]</code> are |
| compared using the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html#equals(int%5B%5D,int%5B%5D)" title="class or interface in java.util" class="external-link"><code>Arrays.equals(int[], int[])</code></a> method.</p> |
| |
| <h2>Thread safety</h2> |
| The same <code>WeakValueHashMap</code> instance can be safely used by many threads without synchronization on the part |
| of the caller. But if a sequence of two or more method calls need to appear atomic from other threads perspective, |
| then the caller can synchronize on <code>this</code>.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/WeakHashMap.html" title="class or interface in java.util" class="external-link"><code>WeakHashMap</code></a></li> |
| <li><a href="WeakHashSet.html" title="class in org.apache.sis.util.collection"><code>WeakHashSet</code></a></li> |
| <li><a href="Cache.html" title="class in org.apache.sis.util.collection"><code>Cache</code></a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.util.AbstractMap">Nested classes/interfaces inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleEntry.html" title="class or interface in java.util" class="external-link">AbstractMap.SimpleEntry</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleEntry.html" title="class or interface in java.util" class="external-link">K</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleEntry.html" title="class or interface in java.util" class="external-link">V</a>>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleImmutableEntry.html" title="class or interface in java.util" class="external-link">AbstractMap.SimpleImmutableEntry</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleImmutableEntry.html" title="class or interface in java.util" class="external-link">K</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.SimpleImmutableEntry.html" title="class or interface in java.util" class="external-link">V</a>></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Class)" class="member-name-link">WeakValueHashMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>> keyType)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new <code>WeakValueHashMap</code>.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.Class,boolean)" class="member-name-link">WeakValueHashMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>> keyType, |
| boolean identity)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new <code>WeakValueHashMap</code>, optionally using reference-equality in place of object-equality.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all of the elements from this map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#containsKey(java.lang.Object)" class="member-name-link">containsKey</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if this map contains a mapping for the specified key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#containsValue(java.lang.Object)" class="member-name-link">containsValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if this map maps one or more keys to this value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#entrySet()" class="member-name-link">entrySet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a set view of the mappings contained in this map.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.Object)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value to which this map maps the specified key.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#put(K,V)" class="member-name-link">put</a><wbr>(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Associates the specified value with the specified key in this map.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putIfAbsent(K,V)" class="member-name-link">putIfAbsent</a><wbr>(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Associates the specified value with the specified key in this map if no value were previously associated.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.Object)" class="member-name-link">remove</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes the mapping for this key from this map if present.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.Object,java.lang.Object)" class="member-name-link">remove</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes the entry for the specified key only if it is currently mapped to the specified value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replace(K,V)" class="member-name-link">replace</a><wbr>(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces the entry for the specified key only if it is currently mapped to some value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replace(K,V,V)" class="member-name-link">replace</a><wbr>(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> oldValue, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces the entry for the specified key only if currently mapped to the specified value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of key-value mappings in this map.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractMap">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#clone()" title="class or interface in java.util" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#equals(java.lang.Object)" title="class or interface in java.util" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#hashCode()" title="class or interface in java.util" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#isEmpty()" title="class or interface in java.util" class="external-link">isEmpty</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#keySet()" title="class or interface in java.util" class="external-link">keySet</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#putAll(java.util.Map)" title="class or interface in java.util" class="external-link">putAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#toString()" title="class or interface in java.util" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#values()" title="class or interface in java.util" class="external-link">values</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Map">Methods inherited from interface <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#compute(K,java.util.function.BiFunction)" title="class or interface in java.util" class="external-link">compute</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#computeIfAbsent(K,java.util.function.Function)" title="class or interface in java.util" class="external-link">computeIfAbsent</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#computeIfPresent(K,java.util.function.BiFunction)" title="class or interface in java.util" class="external-link">computeIfPresent</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#forEach(java.util.function.BiConsumer)" title="class or interface in java.util" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#getOrDefault(java.lang.Object,V)" title="class or interface in java.util" class="external-link">getOrDefault</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#merge(K,V,java.util.function.BiFunction)" title="class or interface in java.util" class="external-link">merge</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#replaceAll(java.util.function.BiFunction)" title="class or interface in java.util" class="external-link">replaceAll</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.Class)"> |
| <h3>WeakValueHashMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WeakValueHashMap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>> keyType)</span></div> |
| <div class="block">Creates a new <code>WeakValueHashMap</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyType</code> - the type of keys in the map.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.Class,boolean)"> |
| <h3>WeakValueHashMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WeakValueHashMap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>> keyType, |
| boolean identity)</span></div> |
| <div class="block">Creates a new <code>WeakValueHashMap</code>, optionally using reference-equality in place of object-equality. |
| If <code>identity</code> is <code>true</code>, then two keys <code>k1</code> and <code>k2</code> are considered equal if and |
| only if <code>(k1 == k2)</code> instead of if <code>k1.equals(k2)</code>. |
| |
| <p>Reference-equality semantic is rarely used. See the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/IdentityHashMap.html" title="class or interface in java.util" class="external-link"><code>IdentityHashMap</code></a> class javadoc |
| for a discussion about drawbacks and use cases when reference-equality semantic is useful.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyType</code> - the type of keys in the map.</dd> |
| <dd><code>identity</code> - <code>true</code> if the map shall use reference-equality in place of object-equality |
| when comparing keys, or <code>false</code> for the standard behavior.</dd> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <div class="block">Returns the number of key-value mappings in this map.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#size()" title="class or interface in java.util" class="external-link">size</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#size()" title="class or interface in java.util" class="external-link">size</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the number of entries in this map.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsKey(java.lang.Object)"> |
| <h3>containsKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsKey</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</span></div> |
| <div class="block">Returns <code>true</code> if this map contains a mapping for the specified key. |
| Null keys are considered never present.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#containsKey(java.lang.Object)" title="class or interface in java.util" class="external-link">containsKey</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#containsKey(java.lang.Object)" title="class or interface in java.util" class="external-link">containsKey</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key whose presence in this map is to be tested.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this map contains a mapping for the specified key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsValue(java.lang.Object)"> |
| <h3>containsValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block">Returns <code>true</code> if this map maps one or more keys to this value. |
| Null values are considered never present.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#containsValue(java.lang.Object)" title="class or interface in java.util" class="external-link">containsValue</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#containsValue(java.lang.Object)" title="class or interface in java.util" class="external-link">containsValue</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - value whose presence in this map is to be tested.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this map maps one or more keys to this value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.lang.Object)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</span></div> |
| <div class="block">Returns the value to which this map maps the specified key. |
| Returns <code>null</code> if the map contains no mapping for this key. |
| Null keys are considered never present.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#get(java.lang.Object)" title="class or interface in java.util" class="external-link">get</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#get(java.lang.Object)" title="class or interface in java.util" class="external-link">get</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key whose associated value is to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the value to which this map maps the specified key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(K,V)"> |
| <h3 id="put(java.lang.Object,java.lang.Object)">put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></span> <span class="element-name">put</span><wbr><span class="parameters">(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</span></div> |
| <div class="block">Associates the specified value with the specified key in this map. |
| The value is associated using a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ref/WeakReference.html" title="class or interface in java.lang.ref" class="external-link"><code>WeakReference</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#put(K,V)" title="class or interface in java.util" class="external-link">put</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#put(K,V)" title="class or interface in java.util" class="external-link">put</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key with which the specified value is to be associated.</dd> |
| <dd><code>value</code> - value to be associated with the specified key.</dd> |
| <dt>Returns:</dt> |
| <dd>the previous value associated with specified key, or <code>null</code> if there was no mapping for the key.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if the key or the value is <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(K,V)"> |
| <h3 id="putIfAbsent(java.lang.Object,java.lang.Object)">putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</span></div> |
| <div class="block">Associates the specified value with the specified key in this map if no value were previously associated. |
| If another value is already associated to the given key, then the map is left unchanged and the current |
| value is returned. Otherwise the specified value is associated to the key using a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ref/WeakReference.html" title="class or interface in java.lang.ref" class="external-link"><code>WeakReference</code></a> |
| and <code>null</code> is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key with which the specified value is to be associated.</dd> |
| <dd><code>value</code> - value to be associated with the specified key.</dd> |
| <dt>Returns:</dt> |
| <dd>the current value associated with specified key, or <code>null</code> if there was no mapping for the key.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if the key or the value is <code>null</code>.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(K,V)"> |
| <h3 id="replace(java.lang.Object,java.lang.Object)">replace</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></span> <span class="element-name">replace</span><wbr><span class="parameters">(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> value)</span></div> |
| <div class="block">Replaces the entry for the specified key only if it is currently mapped to some value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key with which the specified value is to be associated.</dd> |
| <dd><code>value</code> - value to be associated with the specified key.</dd> |
| <dt>Returns:</dt> |
| <dd>the previous value associated with specified key, or <code>null</code> if there was no mapping for the key.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if the value is <code>null</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(K,V,V)"> |
| <h3 id="replace(java.lang.Object,java.lang.Object,java.lang.Object)">replace</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replace</span><wbr><span class="parameters">(<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a> key, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> oldValue, |
| <a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a> newValue)</span></div> |
| <div class="block">Replaces the entry for the specified key only if currently mapped to the specified value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key with which the specified value is to be associated.</dd> |
| <dd><code>oldValue</code> - value expected to be associated with the specified key.</dd> |
| <dd><code>newValue</code> - value to be associated with the specified key.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the value was replaced.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if the new value is <code>null</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(java.lang.Object)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a></span> <span class="element-name">remove</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key)</span></div> |
| <div class="block">Removes the mapping for this key from this map if present.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key whose mapping is to be removed from the map.</dd> |
| <dt>Returns:</dt> |
| <dd>previous value associated with specified key, or <code>null</code> if there was no entry for the key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(java.lang.Object,java.lang.Object)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">remove</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block">Removes the entry for the specified key only if it is currently mapped to the specified value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - key whose mapping is to be removed from the map.</dd> |
| <dd><code>value</code> - value expected to be associated with the specified key.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the value was removed.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Removes all of the elements from this map.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#clear()" title="class or interface in java.util" class="external-link">clear</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#clear()" title="class or interface in java.util" class="external-link">clear</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="entrySet()"> |
| <h3>entrySet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>>></span> <span class="element-name">entrySet</span>()</div> |
| <div class="block">Returns a set view of the mappings contained in this map. |
| Each element in this set is a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link"><code>Map.Entry</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#entrySet()" title="class or interface in java.util" class="external-link">entrySet</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html#entrySet()" title="class or interface in java.util" class="external-link">entrySet</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/AbstractMap.html" title="class or interface in java.util" class="external-link">AbstractMap</a><<a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">K</a>,<wbr><a href="WeakValueHashMap.html" title="type parameter in WeakValueHashMap">V</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>a set view of the mappings contained in this map.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |