Интерфейс 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> |
comparingByKey() Возвращает компаратор, сравнивающий |
static <K,V> Comparator<Map.Entry<K,V>> |
comparingByKey(Comparator<? super K> cmp) Возвращает компаратор, сравнивающий |
static <K,V extends Comparable<? super V>> |
comparingByValue() Возвращает компаратор, сравнивающий |
static <K,V> Comparator<Map.Entry<K,V>> |
comparingByValue(Comparator<? super V> cmp) Возвращает компаратор, сравнивающий |
boolean |
equals(Object o) Сравнивает указанный объект с этим элементом для равенства. |
K |
getKey() Возвращает ключ, соответствующий этому элементу. |
V |
getValue() Возвращает значение, соответствующее этому элементу. |
int |
hashCode() Возвращает значение хэш-кода для этого элемента карты. |
V |
setValue(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 при сравнении элемента с нулевым ключом.
- Параметры типа:
-
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 при сравнении элемента с нулевыми значениями.
- Параметры типа:
-
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.