Интерфейс Map.Entry<K,​V>

Все известные реализующие классы:
AbstractMap.SimpleEntry, AbstractMap.SimpleImmutableEntry
Окружающий интерфейс:
Map<K,​V>
public static interface Map.Entry<K,V>

Элемент карты (пара ключ-значение). Метод Map.entrySet возвращает представление коллекции карты, элементы которой являются объектами этого класса. Единственный способ получить ссылку на элемент карты — из итератора этого представления коллекции. Эти Map.Entry объекты допустимы только на время итерации; более формально, поведение элемента карты не определено, если базовая карта была модифицирована после того, как элемент был возвращен итератором, за исключением операции setValue на элементе карты.

С:
1.2
См. также:
Map.entrySet()

Методы

Модификатор и типМетодОписание
static <K extends Comparable<? super K>,​V>
Comparator<Map.Entry<K,​V>>
comparingByKey()

Возвращает компаратор, который сравнивает Map.Entry в естественном порядке по ключу.

static <K,​V>
Comparator<Map.Entry<K,​V>>
comparingByKey​(Comparator<? super K> cmp)

Возвращает компаратор, который сравнивает Map.Entry по ключу, используя предоставленный Comparator.

static <K,​V extends Comparable<? super V>>
Comparator<Map.Entry<K,​V>>
comparingByValue()

Возвращает компаратор, который сравнивает Map.Entry в естественном порядке по значению.

static <K,​V>
Comparator<Map.Entry<K,​V>>
comparingByValue​(Comparator<? super V> cmp)

Возвращает компаратор, который сравнивает Map.Entry по значению, используя предоставленный Comparator.

booleanequals​(Object o)

Сравнивает указанный объект с этим элементом на равенство.

KgetKey()

Возвращает ключ, соответствующий этому элементу.

VgetValue()

Возвращает значение, соответствующее этому элементу.

inthashCode()

Возвращает значение хэш-кода для этого элемента карты.

VsetValue​(V value)

Заменяет значение, соответствующее этому элементу, заданным значением (необязательная операция).

Методы

getKey

K getKey()

Возвращает ключ, соответствующий этому элементу.

Возвращает:
ключ, соответствующий этому элементу
Исключения:
IllegalStateException - реализации могут, но не обязаны, сбрасывать это исключение, если элемент был удален из базовой карты.

getValue

V getValue()

Возвращает значение, соответствующее этому элементу. Если сопоставление было удалено из базовой карты (операцией итератора remove), результаты этого вызова не определены.

Возвращает:
значение, соответствующее этому элементу
Исключения:
IllegalStateException - реализации могут, но не обязаны, сбрасывать это исключение, если элемент был удален из базовой карты.

setValue

V setValue(V value)

Заменяет значение, соответствующее этому элементу, указанным значением (необязательная операция). (Записывает в карту). Поведение этого вызова не определено, если сопоставление уже было удалено из карты (операцией итератора remove).

Параметры:
value - новое значение, которое будет храниться в этом элементе
Возвращает:
старое значение, соответствующее элементу
Исключения:
UnsupportedOperationException - если операция put не поддерживается базовой картой
ClassCastException - если класс указанного значения препятствует его хранению в базовой карте
NullPointerException - если базовая карта не допускает null-значений, а указанное значение null
IllegalArgumentException - если некоторые свойства этого значения препятствуют его хранению в базовой карте
IllegalStateException - реализации могут, но не обязаны, сбрасывать это исключение, если элемент был удален из базовой карты.

equals

boolean equals(Object o)

Сравнивает указанный объект с этим элементом на равенство. Возвращает true если данный объект также является элементом карты, и два элемента представляют одно и то же сопоставление. Более формально, два элемента e1 и e2 представляют одно и то же сопоставление, если

(e1.getKey()==null ?
      e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
     (e1.getValue()==null ?
      e2.getValue()==null : e1.getValue().equals(e2.getValue()))
Это гарантирует, что метод equals работает правильно в разных реализациях интерфейса Map.Entry.

Переопределяет:
equals в классе Object
Параметры:
o - объект, который необходимо сравнить на равенство с этим элементом карты
Возвращает:
true если указанный объект равен этому элементу карты
См. также:
Object.hashCode(), HashMap

hashCode

int hashCode()

Возвращает значение хэш-кода для этого элемента карты. Хэш-код элемента карты e определен как:

(e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
     (e.getValue()==null ? 0 : e.getValue().hashCode())
Это гарантирует, что e1.equals(e2) подразумевает, что e1.hashCode()==e2.hashCode() для любых двух элементов e1 и e2, как требуется общим контрактом Object.hashCode.

Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого элемента карты
См. также:
Object.hashCode(), Object.equals(Object), equals(Object)

comparingByKey

static <K extends Comparable<? super K>,V> Comparator<Map.Entry<K,​V>> comparingByKey()

Возвращает компаратор, который сравнивает Map.Entry в естественном порядке по ключу.

Возвращаемый компаратор сериализуем и выбрасывает NullPointerException при сравнении элемента с null-ключом.

Параметры типа:
K - тип Comparable ключей карты
V - тип значений карты
Возвращает:
компаратор, который сравнивает Map.Entry в естественном порядке по ключу.
С:
1.8
См. также:
Comparable

comparingByValue

static <K,V extends Comparable<? super V>> Comparator<Map.Entry<K,​V>> comparingByValue()

Возвращает компаратор, который сравнивает Map.Entry в естественном порядке по значению.

Возвращаемый компаратор сериализуем и выбрасывает NullPointerException при сравнении элемента со значениями null.

Параметры типа:
K - тип ключей карты
V - тип Comparable значений карты
Возвращает:
компаратор, который сравнивает Map.Entry в естественном порядке по значению.
С:
1.8
См. также:
Comparable

comparingByKey

static <K,V> Comparator<Map.Entry<K,​V>> comparingByKey​(Comparator<? super K> cmp)

Возвращает компаратор, который сравнивает Map.Entry по ключу, используя данный Comparator.

Возвращаемый компаратор сериализуем, если указанный компаратор также сериализуем.

Параметры типа:
K - тип ключей карты
V - тип значений карты
Параметры:
cmp - компаратор ключей
Возвращает:
компаратор, который сравнивает Map.Entry по ключу.
С:
1.8

comparingByValue

static <K,V> Comparator<Map.Entry<K,​V>> comparingByValue​(Comparator<? super V> cmp)

Возвращает компаратор, который сравнивает Map.Entry по значению, используя данный Comparator.

Возвращаемый компаратор сериализуем, если указанный компаратор также сериализуем.

Параметры типа:
K - тип ключей карты
V - тип значений карты
Параметры:
cmp - компаратор значений
Возвращает:
компаратор, который сравнивает Map.Entry по значению.
С:
1.8

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html

Spec-Zone .ru
спецификации, руководства, описания, API