AbstractMap.SimpleEntry
, AbstractMap.SimpleImmutableEntry
public static interface Map.Entry<K,V>
A map entry (key-value pair). The Entry may be unmodifiable, or the value may be modifiable if the optional
setValue
method is implemented. The Entry may be independent of any map, or it may represent an entry of the entry-set view of a map.
Instances of the Map.Entry
interface may be obtained by iterating the entry-set view of a map. These instances maintain a connection to the original, backing map. This connection to the backing map is valid only for the duration of iteration over the entry-set view. During iteration of the entry-set view, if supported by the backing map, a change to a Map.Entry
's value via the setValue
method will be visible in the backing map. The behavior of such a Map.Entry
instance is undefined outside of iteration of the map's entry-set view. It is also undefined if the backing map has been modified after the Map.Entry
was returned by the iterator, except through the Map.Entry.setValue
method. In particular, a change to the value of a mapping in the backing map might or might not be visible in the corresponding Map.Entry
element of the entry-set view.
Map.Entry
instance that is disconnected from a backing map by using the copyOf
method. For example, the following creates a snapshot of a map's entries that is guaranteed not to change even if the original map is modified:
var entries = map.entrySet().stream().map(Map.Entry::copyOf).toList()
Returns a comparator that compares
Map.Entry
in natural order on key.
Returns a comparator that compares
Map.Entry
in natural order on value.
Returns a copy of the given Map.Entry
.
boolean
Compares the specified object with this entry for equality.
Returns the key corresponding to this entry.
Returns the value corresponding to this entry.
int
Returns the hash code value for this map entry.
Replaces the value corresponding to this entry with the specified value (optional operation).
Returns the key corresponding to this entry.
IllegalStateException
- implementations may, but are not required to, throw this exception if the entry has been removed from the backing map.
Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove
operation), the results of this call are undefined.
IllegalStateException
- implementations may, but are not required to, throw this exception if the entry has been removed from the backing map.
Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove
operation).
value
- new value to be stored in this entry
UnsupportedOperationException
- if the put
operation is not supported by the backing map
ClassCastException
- if the class of the specified value prevents it from being stored in the backing map
NullPointerException
- if the backing map does not permit null values, and the specified value is null
IllegalArgumentException
- if some property of this value prevents it from being stored in the backing map
IllegalStateException
- implementations may, but are not required to, throw this exception if the entry has been removed from the backing map.
Compares the specified object with this entry for equality. Returns
true
if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries
e1
and
e2
represent the same mapping if
(e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) && (e1.getValue()==null ? e2.getValue()==null : e1.getValue().equals(e2.getValue()))
This ensures that the
equals
method works properly across different implementations of the
Map.Entry
interface.
int hashCode()
Returns the hash code value for this map entry. The hash code of a map entry
e
is defined to be:
(e.getKey()==null ? 0 : e.getKey().hashCode()) ^ (e.getValue()==null ? 0 : e.getValue().hashCode())
This ensures that
e1.equals(e2)
implies that
e1.hashCode()==e2.hashCode()
for any two Entries
e1
and
e2
, as required by the general contract of
Object.hashCode
.
Returns a comparator that compares
Map.Entry
in natural order on key.
The returned comparator is serializable and throws NullPointerException
when comparing an entry with a null key.
K
- the Comparable
type of then map keys
V
- the type of the map values
Map.Entry
in natural order on key.
Returns a comparator that compares
Map.Entry
in natural order on value.
The returned comparator is serializable and throws NullPointerException
when comparing an entry with null values.
K
- the type of the map keys
V
- the Comparable
type of the map values
Map.Entry
in natural order on value.
Returns a comparator that compares
Map.Entry
by key using the given
Comparator
.
The returned comparator is serializable if the specified comparator is also serializable.
K
- the type of the map keys
V
- the type of the map values
cmp
- the key Comparator
Map.Entry
by the key.
Returns a comparator that compares
Map.Entry
by value using the given
Comparator
.
The returned comparator is serializable if the specified comparator is also serializable.
K
- the type of the map keys
V
- the type of the map values
cmp
- the value Comparator
Map.Entry
by the value.
Returns a copy of the given
Map.Entry
. The returned instance is not associated with any map. The returned instance has the same characteristics as instances returned by the
Map::entry
method.
copyOf
method may be used to create a Map.Entry
instance, containing the same key and value, that is independent of any map.
copyOf
or Map::entry
, calling copyOf
will generally not create another copy.
K
- the type of the key
V
- the type of the value
e
- the entry to be copied
NullPointerException
- if e is null or if either of its key or value is null
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4