forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMap.html
More file actions
2469 lines (2413 loc) · 132 KB
/
Map.html
File metadata and controls
2469 lines (2413 loc) · 132 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Map (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.util.Map interface">
<meta name="keywords" content="size()">
<meta name="keywords" content="isEmpty()">
<meta name="keywords" content="containsKey()">
<meta name="keywords" content="containsValue()">
<meta name="keywords" content="get()">
<meta name="keywords" content="put()">
<meta name="keywords" content="remove()">
<meta name="keywords" content="putAll()">
<meta name="keywords" content="clear()">
<meta name="keywords" content="keySet()">
<meta name="keywords" content="values()">
<meta name="keywords" content="entrySet()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="getOrDefault()">
<meta name="keywords" content="forEach()">
<meta name="keywords" content="replaceAll()">
<meta name="keywords" content="putIfAbsent()">
<meta name="keywords" content="replace()">
<meta name="keywords" content="computeIfAbsent()">
<meta name="keywords" content="computeIfPresent()">
<meta name="keywords" content="compute()">
<meta name="keywords" content="merge()">
<meta name="keywords" content="of()">
<meta name="keywords" content="ofEntries()">
<meta name="keywords" content="entry()">
<meta name="keywords" content="copyOf()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Map (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":18,"i2":18,"i3":18,"i4":6,"i5":6,"i6":1,"i7":1,"i8":6,"i9":6,"i10":18,"i11":6,"i12":18,"i13":6,"i14":6,"i15":6,"i16":18,"i17":1,"i18":1,"i19":1,"i20":1,"i21":1,"i22":1,"i23":1,"i24":1,"i25":1,"i26":1,"i27":1,"i28":1,"i29":6,"i30":6,"i31":18,"i32":6,"i33":18,"i34":18,"i35":18,"i36":18,"i37":6,"i38":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Map.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </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>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.util</a></div>
<h2 title="Interface Map" class="title">Interface Map<K,​V></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys maintained by this map</dd>
<dd><code>V</code> - the type of mapped values</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../../../java.scripting/javax/script/Bindings.html" title="interface in javax.script">Bindings</a></code>, <code><a href="concurrent/ConcurrentMap.html" title="interface in java.util.concurrent">ConcurrentMap</a><K,​V></code>, <code><a href="concurrent/ConcurrentNavigableMap.html" title="interface in java.util.concurrent">ConcurrentNavigableMap</a><K,​V></code>, <code><a href="NavigableMap.html" title="interface in java.util">NavigableMap</a><K,​V></code>, <code><a href="SortedMap.html" title="interface in java.util">SortedMap</a><K,​V></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractMap.html" title="class in java.util">AbstractMap</a></code>, <code><a href="jar/Attributes.html" title="class in java.util.jar">Attributes</a></code>, <code><a href="../security/AuthProvider.html" title="class in java.security">AuthProvider</a></code>, <code><a href="concurrent/ConcurrentHashMap.html" title="class in java.util.concurrent">ConcurrentHashMap</a></code>, <code><a href="concurrent/ConcurrentSkipListMap.html" title="class in java.util.concurrent">ConcurrentSkipListMap</a></code>, <code><a href="EnumMap.html" title="class in java.util">EnumMap</a></code>, <code><a href="HashMap.html" title="class in java.util">HashMap</a></code>, <code><a href="Hashtable.html" title="class in java.util">Hashtable</a></code>, <code><a href="../../../jdk.httpserver/com/sun/net/httpserver/Headers.html" title="class in com.sun.net.httpserver">Headers</a></code>, <code><a href="IdentityHashMap.html" title="class in java.util">IdentityHashMap</a></code>, <code><a href="LinkedHashMap.html" title="class in java.util">LinkedHashMap</a></code>, <code><a href="../../../java.desktop/javax/print/attribute/standard/PrinterStateReasons.html" title="class in javax.print.attribute.standard">PrinterStateReasons</a></code>, <code><a href="Properties.html" title="class in java.util">Properties</a></code>, <code><a href="../security/Provider.html" title="class in java.security">Provider</a></code>, <code><a href="../../../java.desktop/java/awt/RenderingHints.html" title="class in java.awt">RenderingHints</a></code>, <code><a href="../../../jdk.scripting.nashorn/jdk/nashorn/api/scripting/ScriptObjectMirror.html" title="class in jdk.nashorn.api.scripting">ScriptObjectMirror</a></code>, <code><a href="../../../java.scripting/javax/script/SimpleBindings.html" title="class in javax.script">SimpleBindings</a></code>, <code><a href="../../../java.management/javax/management/openmbean/TabularDataSupport.html" title="class in javax.management.openmbean">TabularDataSupport</a></code>, <code><a href="TreeMap.html" title="class in java.util">TreeMap</a></code>, <code><a href="../../../java.desktop/javax/swing/UIDefaults.html" title="class in javax.swing">UIDefaults</a></code>, <code><a href="WeakHashMap.html" title="class in java.util">WeakHashMap</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Map<K,​V></span></pre>
<div class="block">An object that maps keys to values. A map cannot contain duplicate keys;
each key can map to at most one value.
<p>This interface takes the place of the <code>Dictionary</code> class, which
was a totally abstract class rather than an interface.
<p>The <code>Map</code> interface provides three <i>collection views</i>, which
allow a map's contents to be viewed as a set of keys, collection of values,
or set of key-value mappings. The <i>order</i> of a map is defined as
the order in which the iterators on the map's collection views return their
elements. Some map implementations, like the <code>TreeMap</code> class, make
specific guarantees as to their order; others, like the <code>HashMap</code>
class, do not.
<p>Note: great care must be exercised if mutable objects are used as map
keys. The behavior of a map is not specified if the value of an object is
changed in a manner that affects <code>equals</code> comparisons while the
object is a key in the map. A special case of this prohibition is that it
is not permissible for a map to contain itself as a key. While it is
permissible for a map to contain itself as a value, extreme caution is
advised: the <code>equals</code> and <code>hashCode</code> methods are no longer
well defined on such a map.
<p>All general-purpose map implementation classes should provide two
"standard" constructors: a void (no arguments) constructor which creates an
empty map, and a constructor with a single argument of type <code>Map</code>,
which creates a new map with the same key-value mappings as its argument.
In effect, the latter constructor allows the user to copy any map,
producing an equivalent map of the desired class. There is no way to
enforce this recommendation (as interfaces cannot contain constructors) but
all of the general-purpose map implementations in the JDK comply.
<p>The "destructive" methods contained in this interface, that is, the
methods that modify the map on which they operate, are specified to throw
<code>UnsupportedOperationException</code> if this map does not support the
operation. If this is the case, these methods may, but are not required
to, throw an <code>UnsupportedOperationException</code> if the invocation would
have no effect on the map. For example, invoking the <a href="#putAll(java.util.Map)"><code>putAll(Map)</code></a>
method on an unmodifiable map may, but is not required to, throw the
exception if the map whose mappings are to be "superimposed" is empty.
<p>Some map implementations have restrictions on the keys and values they
may contain. For example, some implementations prohibit null keys and
values, and some have restrictions on the types of their keys. Attempting
to insert an ineligible key or value throws an unchecked exception,
typically <code>NullPointerException</code> or <code>ClassCastException</code>.
Attempting to query the presence of an ineligible key or value may throw an
exception, or it may simply return false; some implementations will exhibit
the former behavior and some will exhibit the latter. More generally,
attempting an operation on an ineligible key or value whose completion
would not result in the insertion of an ineligible element into the map may
throw an exception or it may succeed, at the option of the implementation.
Such exceptions are marked as "optional" in the specification for this
interface.
<p>Many methods in Collections Framework interfaces are defined
in terms of the <a href="../lang/Object.html#equals(java.lang.Object)"><code>equals</code></a> method. For
example, the specification for the <a href="#containsKey(java.lang.Object)"><code>containsKey(Object key)</code></a> method says: "returns <code>true</code> if and
only if this map contains a mapping for a key <code>k</code> such that
<code>(key==null ? k==null : key.equals(k))</code>." This specification should
<i>not</i> be construed to imply that invoking <code>Map.containsKey</code>
with a non-null argument <code>key</code> will cause <code>key.equals(k)</code> to
be invoked for any key <code>k</code>. Implementations are free to
implement optimizations whereby the <code>equals</code> invocation is avoided,
for example, by first comparing the hash codes of the two keys. (The
<a href="../lang/Object.html#hashCode()"><code>Object.hashCode()</code></a> specification guarantees that two objects with
unequal hash codes cannot be equal.) More generally, implementations of
the various Collections Framework interfaces are free to take advantage of
the specified behavior of underlying <a href="../lang/Object.html" title="class in java.lang"><code>Object</code></a> methods wherever the
implementor deems it appropriate.
<p>Some map operations which perform recursive traversal of the map may fail
with an exception for self-referential instances where the map directly or
indirectly contains itself. This includes the <code>clone()</code>,
<code>equals()</code>, <code>hashCode()</code> and <code>toString()</code> methods.
Implementations may optionally handle the self-referential scenario, however
most current implementations do not do so.
<h2><a id="unmodifiable">Unmodifiable Maps</a></h2>
<p>The <a href="#of()"><code>Map.of</code></a>,
<a href="#ofEntries(java.util.Map.Entry...)"><code>Map.ofEntries</code></a>, and
<a href="#copyOf(java.util.Map)"><code>Map.copyOf</code></a>
static factory methods provide a convenient way to create unmodifiable maps.
The <code>Map</code>
instances created by these methods have the following characteristics:
<ul>
<li>They are <a href="Collection.html#unmodifiable"><i>unmodifiable</i></a>. Keys and values
cannot be added, removed, or updated. Calling any mutator method on the Map
will always cause <code>UnsupportedOperationException</code> to be thrown.
However, if the contained keys or values are themselves mutable, this may cause the
Map to behave inconsistently or its contents to appear to change.
<li>They disallow <code>null</code> keys and values. Attempts to create them with
<code>null</code> keys or values result in <code>NullPointerException</code>.
<li>They are serializable if all keys and values are serializable.
<li>They reject duplicate keys at creation time. Duplicate keys
passed to a static factory method result in <code>IllegalArgumentException</code>.
<li>The iteration order of mappings is unspecified and is subject to change.
<li>They are <a href="../lang/doc-files/ValueBased.html">value-based</a>.
Callers should make no assumptions about the identity of the returned instances.
Factories are free to create new instances or reuse existing ones. Therefore,
identity-sensitive operations on these instances (reference equality (<code>==</code>),
identity hash code, and synchronization) are unreliable and should be avoided.
<li>They are serialized as specified on the
<a href="../../../serialized-form.html#java.util.CollSer">Serialized Form</a>
page.
</ul>
<p>This interface is a member of the
<a href="../../../java.base/java/util/package-summary.html#CollectionsFramework">
Java Collections Framework</a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="HashMap.html" title="class in java.util"><code>HashMap</code></a>,
<a href="TreeMap.html" title="class in java.util"><code>TreeMap</code></a>,
<a href="Hashtable.html" title="class in java.util"><code>Hashtable</code></a>,
<a href="SortedMap.html" title="interface in java.util"><code>SortedMap</code></a>,
<a href="Collection.html" title="interface in java.util"><code>Collection</code></a>,
<a href="Set.html" title="interface in java.util"><code>Set</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<div class="memberSummary">
<table>
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Map.Entry.html" title="interface in java.util">Map.Entry</a><<a href="Map.Entry.html" title="type parameter in Map.Entry">K</a>,​<a href="Map.Entry.html" title="type parameter in Map.Entry">V</a>></span></code></th>
<td class="colLast">
<div class="block">A map entry (key-value pair).</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Default Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes all of the mappings from this map (optional operation).</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compute(K,java.util.function.BiFunction)">compute</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="function/BiFunction.html" title="interface in java.util.function">BiFunction</a><? super <a href="Map.html" title="type parameter in Map">K</a>,​? super <a href="Map.html" title="type parameter in Map">V</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> remappingFunction)</code></th>
<td class="colLast">
<div class="block">Attempts to compute a mapping for the specified key and its current
mapped value (or <code>null</code> if there is no current mapping).</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeIfAbsent(K,java.util.function.Function)">computeIfAbsent</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="function/Function.html" title="interface in java.util.function">Function</a><? super <a href="Map.html" title="type parameter in Map">K</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> mappingFunction)</code></th>
<td class="colLast">
<div class="block">If the specified key is not already associated with a value (or is mapped
to <code>null</code>), attempts to compute its value using the given mapping
function and enters it into this map unless <code>null</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeIfPresent(K,java.util.function.BiFunction)">computeIfPresent</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="function/BiFunction.html" title="interface in java.util.function">BiFunction</a><? super <a href="Map.html" title="type parameter in Map">K</a>,​? super <a href="Map.html" title="type parameter in Map">V</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> remappingFunction)</code></th>
<td class="colLast">
<div class="block">If the value for the specified key is present and non-null, attempts to
compute a new mapping given the key and its current mapped value.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsKey(java.lang.Object)">containsKey</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this map contains a mapping for the specified
key.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsValue(java.lang.Object)">containsValue</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> value)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this map maps one or more keys to the
specified value.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyOf(java.util.Map)">copyOf</a></span>​(<a href="Map.html" title="interface in java.util">Map</a><? extends K,​? extends V> map)</code></th>
<td class="colLast">
<div class="block">Returns an <a href="#unmodifiable">unmodifiable Map</a> containing the entries
of the given Map.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static <K,​V><br><a href="Map.Entry.html" title="interface in java.util">Map.Entry</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entry(K,V)">entry</a></span>​(K k,
V v)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable <a href="Map.Entry.html" title="interface in java.util"><code>Map.Entry</code></a> containing the given key and value.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="Set.html" title="interface in java.util">Set</a><<a href="Map.Entry.html" title="interface in java.util">Map.Entry</a><<a href="Map.html" title="type parameter in Map">K</a>,​<a href="Map.html" title="type parameter in Map">V</a>>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entrySet()">entrySet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a <a href="Set.html" title="interface in java.util"><code>Set</code></a> view of the mappings contained in this map.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> o)</code></th>
<td class="colLast">
<div class="block">Compares the specified object with this map for equality.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEach(java.util.function.BiConsumer)">forEach</a></span>​(<a href="function/BiConsumer.html" title="interface in java.util.function">BiConsumer</a><? super <a href="Map.html" title="type parameter in Map">K</a>,​? super <a href="Map.html" title="type parameter in Map">V</a>> action)</code></th>
<td class="colLast">
<div class="block">Performs the given action for each entry in this map until all entries
have been processed or the action throws an exception.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code><a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.Object)">get</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</code></th>
<td class="colLast">
<div class="block">Returns the value to which the specified key is mapped,
or <code>null</code> if this map contains no mapping for the key.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrDefault(java.lang.Object,V)">getOrDefault</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key,
<a href="Map.html" title="type parameter in Map">V</a> defaultValue)</code></th>
<td class="colLast">
<div class="block">Returns the value to which the specified key is mapped, or
<code>defaultValue</code> if this map contains no mapping for the key.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the hash code value for this map.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this map contains no key-value mappings.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code><a href="Set.html" title="interface in java.util">Set</a><<a href="Map.html" title="type parameter in Map">K</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keySet()">keySet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a <a href="Set.html" title="interface in java.util"><code>Set</code></a> view of the keys contained in this map.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(K,V,java.util.function.BiFunction)">merge</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> value,
<a href="function/BiFunction.html" title="interface in java.util.function">BiFunction</a><? super <a href="Map.html" title="type parameter in Map">V</a>,​? super <a href="Map.html" title="type parameter in Map">V</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> remappingFunction)</code></th>
<td class="colLast">
<div class="block">If the specified key is not already associated with a value or is
associated with null, associates it with the given non-null value.</div>
</td>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of()">of</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing zero mappings.</div>
</td>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V)">of</a></span>​(K k1,
V v1)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing a single mapping.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing two mappings.</div>
</td>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing three mappings.</div>
</td>
</tr>
<tr class="rowColor" id="i21">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing four mappings.</div>
</td>
</tr>
<tr class="altColor" id="i22">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing five mappings.</div>
</td>
</tr>
<tr class="rowColor" id="i23">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5,
K k6,
V v6)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing six mappings.</div>
</td>
</tr>
<tr class="altColor" id="i24">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5,
K k6,
V v6,
K k7,
V v7)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing seven mappings.</div>
</td>
</tr>
<tr class="rowColor" id="i25">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5,
K k6,
V v6,
K k7,
V v7,
K k8,
V v8)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing eight mappings.</div>
</td>
</tr>
<tr class="altColor" id="i26">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5,
K k6,
V v6,
K k7,
V v7,
K k8,
V v8,
K k9,
V v9)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing nine mappings.</div>
</td>
</tr>
<tr class="rowColor" id="i27">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V,K,V)">of</a></span>​(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5,
K k6,
V v6,
K k7,
V v7,
K k8,
V v8,
K k9,
V v9,
K k10,
V v10)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing ten mappings.</div>
</td>
</tr>
<tr class="altColor" id="i28">
<td class="colFirst"><code>static <K,​V><br><a href="Map.html" title="interface in java.util">Map</a><K,​V></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofEntries(java.util.Map.Entry...)">ofEntries</a></span>​(<a href="Map.Entry.html" title="interface in java.util">Map.Entry</a><? extends K,​? extends V>... entries)</code></th>
<td class="colLast">
<div class="block">Returns an unmodifiable map containing keys and values extracted from the given entries.</div>
</td>
</tr>
<tr class="rowColor" id="i29">
<td class="colFirst"><code><a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(K,V)">put</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> value)</code></th>
<td class="colLast">
<div class="block">Associates the specified value with the specified key in this map
(optional operation).</div>
</td>
</tr>
<tr class="altColor" id="i30">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putAll(java.util.Map)">putAll</a></span>​(<a href="Map.html" title="interface in java.util">Map</a><? extends <a href="Map.html" title="type parameter in Map">K</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> m)</code></th>
<td class="colLast">
<div class="block">Copies all of the mappings from the specified map to this map
(optional operation).</div>
</td>
</tr>
<tr class="rowColor" id="i31">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putIfAbsent(K,V)">putIfAbsent</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> value)</code></th>
<td class="colLast">
<div class="block">If the specified key is not already associated with a value (or is mapped
to <code>null</code>) associates it with the given value and returns
<code>null</code>, else returns the current value.</div>
</td>
</tr>
<tr class="altColor" id="i32">
<td class="colFirst"><code><a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.Object)">remove</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</code></th>
<td class="colLast">
<div class="block">Removes the mapping for a key from this map if it is present
(optional operation).</div>
</td>
</tr>
<tr class="rowColor" id="i33">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.Object,java.lang.Object)">remove</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key,
<a href="../lang/Object.html" title="class in java.lang">Object</a> value)</code></th>
<td class="colLast">
<div class="block">Removes the entry for the specified key only if it is currently
mapped to the specified value.</div>
</td>
</tr>
<tr class="altColor" id="i34">
<td class="colFirst"><code>default <a href="Map.html" title="type parameter in Map">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replace(K,V)">replace</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> value)</code></th>
<td class="colLast">
<div class="block">Replaces the entry for the specified key only if it is
currently mapped to some value.</div>
</td>
</tr>
<tr class="rowColor" id="i35">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replace(K,V,V)">replace</a></span>​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> oldValue,
<a href="Map.html" title="type parameter in Map">V</a> newValue)</code></th>
<td class="colLast">
<div class="block">Replaces the entry for the specified key only if currently
mapped to the specified value.</div>
</td>
</tr>
<tr class="altColor" id="i36">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceAll(java.util.function.BiFunction)">replaceAll</a></span>​(<a href="function/BiFunction.html" title="interface in java.util.function">BiFunction</a><? super <a href="Map.html" title="type parameter in Map">K</a>,​? super <a href="Map.html" title="type parameter in Map">V</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> function)</code></th>
<td class="colLast">
<div class="block">Replaces each entry's value with the result of invoking the given
function on that entry until all entries have been processed or the
function throws an exception.</div>
</td>
</tr>
<tr class="rowColor" id="i37">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of key-value mappings in this map.</div>
</td>
</tr>
<tr class="altColor" id="i38">
<td class="colFirst"><code><a href="Collection.html" title="interface in java.util">Collection</a><<a href="Map.html" title="type parameter in Map">V</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a <a href="Collection.html" title="interface in java.util"><code>Collection</code></a> view of the values contained in this map.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">int size()</pre>
<div class="block">Returns the number of key-value mappings in this map. If the
map contains more than <code>Integer.MAX_VALUE</code> elements, returns
<code>Integer.MAX_VALUE</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of key-value mappings in this map</dd>
</dl>
</li>
</ul>
<a id="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">boolean isEmpty()</pre>
<div class="block">Returns <code>true</code> if this map contains no key-value mappings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map contains no key-value mappings</dd>
</dl>
</li>
</ul>
<a id="containsKey(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre class="methodSignature">boolean containsKey​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</pre>
<div class="block">Returns <code>true</code> if this map contains a mapping for the specified
key. More formally, returns <code>true</code> if and only if
this map contains a mapping for a key <code>k</code> such that
<code>Objects.equals(key, k)</code>. (There can be
at most one such mapping.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - key whose presence in this map is to be tested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map contains a mapping for the specified
key</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the key is of an inappropriate type for
this map
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key is null and this map
does not permit null keys
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
</dl>
</li>
</ul>
<a id="containsValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsValue</h4>
<pre class="methodSignature">boolean containsValue​(<a href="../lang/Object.html" title="class in java.lang">Object</a> value)</pre>
<div class="block">Returns <code>true</code> if this map maps one or more keys to the
specified value. More formally, returns <code>true</code> if and only if
this map contains at least one mapping to a value <code>v</code> such that
<code>Objects.equals(value, v)</code>. This operation
will probably require time linear in the map size for most
implementations of the <code>Map</code> interface.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value whose presence in this map is to be tested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map maps one or more keys to the
specified value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the value is of an inappropriate type for
this map
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified value is null and this
map does not permit null values
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
</dl>
</li>
</ul>
<a id="get(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature"><a href="Map.html" title="type parameter in Map">V</a> get​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</pre>
<div class="block">Returns the value to which the specified key is mapped,
or <code>null</code> if this map contains no mapping for the key.
<p>More formally, if this map contains a mapping from a key
<code>k</code> to a value <code>v</code> such that
<code>Objects.equals(key, k)</code>,
then this method returns <code>v</code>; otherwise
it returns <code>null</code>. (There can be at most one such mapping.)
<p>If this map permits null values, then a return value of
<code>null</code> does not <i>necessarily</i> indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to <code>null</code>. The <a href="#containsKey(java.lang.Object)"><code>containsKey</code></a> operation may be used to distinguish these two cases.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key whose associated value is to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value to which the specified key is mapped, or
<code>null</code> if this map contains no mapping for the key</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the key is of an inappropriate type for
this map
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key is null and this map
does not permit null keys
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
</dl>
</li>
</ul>
<a id="put(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a id="put(K,V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre class="methodSignature"><a href="Map.html" title="type parameter in Map">V</a> put​(<a href="Map.html" title="type parameter in Map">K</a> key,
<a href="Map.html" title="type parameter in Map">V</a> value)</pre>
<div class="block">Associates the specified value with the specified key in this map
(optional operation). If the map previously contained a mapping for
the key, the old value is replaced by the specified value. (A map
<code>m</code> is said to contain a mapping for a key <code>k</code> if and only
if <a href="#containsKey(java.lang.Object)"><code>m.containsKey(k)</code></a> would return
<code>true</code>.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>the previous value associated with <code>key</code>, or
<code>null</code> if there was no mapping for <code>key</code>.
(A <code>null</code> return can also indicate that the map
previously associated <code>null</code> with <code>key</code>,
if the implementation supports <code>null</code> values.)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - if the <code>put</code> operation
is not supported by this map</dd>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the class of the specified key or value
prevents it from being stored in this map</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key or value is null
and this map does not permit null keys or values</dd>
<dd><code><a href="../lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - if some property of the specified key
or value prevents it from being stored in this map</dd>
</dl>
</li>
</ul>
<a id="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre class="methodSignature"><a href="Map.html" title="type parameter in Map">V</a> remove​(<a href="../lang/Object.html" title="class in java.lang">Object</a> key)</pre>
<div class="block">Removes the mapping for a key from this map if it is present
(optional operation). More formally, if this map contains a mapping
from key <code>k</code> to value <code>v</code> such that
<code>Objects.equals(key, k)</code>, that mapping
is removed. (The map can contain at most one such mapping.)
<p>Returns the value to which this map previously associated the key,
or <code>null</code> if the map contained no mapping for the key.
<p>If this map permits null values, then a return value of
<code>null</code> does not <i>necessarily</i> indicate that the map
contained no mapping for the key; it's also possible that the map
explicitly mapped the key to <code>null</code>.
<p>The map will not contain a mapping for the specified key once the
call returns.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - key whose mapping is to be removed from the map</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous value associated with <code>key</code>, or
<code>null</code> if there was no mapping for <code>key</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - if the <code>remove</code> operation
is not supported by this map</dd>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the key is of an inappropriate type for
this map
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key is null and this
map does not permit null keys
(<a href="../../../java.base/java/util/Collection.html#optional-restrictions">optional</a>)</dd>
</dl>
</li>
</ul>
<a id="putAll(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre class="methodSignature">void putAll​(<a href="Map.html" title="interface in java.util">Map</a><? extends <a href="Map.html" title="type parameter in Map">K</a>,​? extends <a href="Map.html" title="type parameter in Map">V</a>> m)</pre>
<div class="block">Copies all of the mappings from the specified map to this map
(optional operation). The effect of this call is equivalent to that
of calling <a href="#put(K,V)"><code>put(k, v)</code></a> on this map once
for each mapping from key <code>k</code> to value <code>v</code> in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - mappings to be stored in this map</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - if the <code>putAll</code> operation
is not supported by this map</dd>
<dd><code><a href="../lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the class of a key or value in the
specified map prevents it from being stored in this map</dd>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified map is null, or if
this map does not permit null keys or values, and the
specified map contains null keys or values</dd>
<dd><code><a href="../lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - if some property of a key or value in
the specified map prevents it from being stored in this map</dd>
</dl>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">void clear()</pre>
<div class="block">Removes all of the mappings from this map (optional operation).
The map will be empty after this call returns.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - if the <code>clear</code> operation
is not supported by this map</dd>
</dl>