archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8038146: Clarify Map.Entry's connection to the underlying map

Browse source 
Reviewed-by: alanb
This commit is contained in:
Stuart Marks 2023-01-20 16:33:48 +00:00
parent b2d3622115
commit c6d5600396
4 changed files with 74 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/java.base/share/classes/java/util/NavigableMap.java
View file

@ -66,12 +66,18 @@ package java.util;
* {@link #pollLastEntry} that return and/or remove the least and
* greatest mappings, if any exist, else returning {@code null}.
*
* <p>Implementations of entry-returning methods are expected to
* return {@code Map.Entry} pairs representing snapshots of mappings
* at the time they were produced, and thus generally do <em>not</em>
* support the optional {@code Entry.setValue} method. Note however
* that it is possible to change mappings in the associated map using
* method {@code put}.
* <p>The methods
* {@link #ceilingEntry},
* {@link #firstEntry},
* {@link #floorEntry},
* {@link #higherEntry},
* {@link #lastEntry},
* {@link #lowerEntry},
* {@link #pollFirstEntry}, and
* {@link #pollLastEntry}
* return {@link Map.Entry} instances that represent snapshots of mappings as
* of the time of the call. They do <em>not</em> support mutation of the
* underlying map via the optional {@link Map.Entry#setValue setValue} method.
*
* <p>Methods
* {@link #subMap(Object, Object) subMap(K, K)},