Класс IdentityHashMap<K,V>

public class IdentityHashMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, Serializable, Cloneable

Этот класс реализует интерфейс Map с помощью хеш-таблицы, используя равенство ссылок вместо равенства объектов при сравнении ключей (и значений). Другими словами, в IdentityHashMap, два ключа k1 и k2 считаются равными тогда и только тогда, когда (k1==k2). (В обычных реализациях Map (например, HashMap) два ключа k1 и k2 считаются равными тогда и только тогда, когда (k1==null ? k2==null : k1.equals(k2)).)

Этот класс — не общепригодная реализация Map! Хотя этот класс реализует интерфейс Map, он намеренно нарушает Map's общий контракт, который предписывает использование метода equals при сравнении объектов. Этот класс предназначен только для редких случаев, когда требуется семантика равенства ссылок.

Типичное применение этого класса — преобразование графов объектов, сохраняющих топологию, такие как сериализация или глубокое копирование. Для выполнения такого преобразования программа должна поддерживать «таблицу узлов», которая отслеживает все ссылки на объекты, которые уже были обработаны. Таблица узлов не должна приравнивать различные объекты, даже если они случайно равны. Другое типичное применение этого класса — поддержка объектов-прокси. Например, средство отладки может захотеть поддерживать объект-прокси для каждого объекта в отлаживаемой программе.

Этот класс предоставляет все необязательные операции с картой и допускает null значения и null ключи. Этот класс не гарантирует порядок карты; в частности, он не гарантирует, что порядок останется постоянным со временем.

Этот класс обеспечивает выполнение базовых операций (get и put ) за постоянное время, предполагая, что функция хеширования системы идентификации (System.identityHashCode(Object)) правильно распределяет элементы по корзинам.

Этот класс имеет один параметр настройки (который влияет на производительность, но не на семантику): ожидаемый максимальный размер. Этот параметр представляет собой максимальное количество сопоставлений ключ-значение, которые, как ожидается, будет содержать карта. Внутренне этот параметр используется для определения количества корзин, первоначально составляющих хеш-таблицу. Точная взаимосвязь между ожидаемым максимальным размером и количеством корзин не определена.

Если размер карты (количество сопоставлений ключ-значение) существенно превышает ожидаемый максимальный размер, количество корзин увеличивается. Увеличение количества корзин («перехеширование») может быть довольно дорогостоящим, поэтому имеет смысл создавать карты идентичности с достаточно большим ожидаемым максимальным размером. С другой стороны, итерация по коллекциям представлений требует времени, пропорционального числу корзин в хеш-таблице, поэтому не стоит устанавливать ожидаемый максимальный размер слишком большим, если вас особенно беспокоит производительность итерации или использование памяти.

Обратите внимание, что эта реализация не синхронизирована. Если несколько потоков одновременно обращаются к карте идентичности и хотя бы один из потоков структурно изменяет карту, её необходимо синхронизировать внешне. (Структурное изменение — это любая операция, которая добавляет или удаляет одно или несколько сопоставлений; простое изменение значения, связанного с ключом, который уже содержится в экземпляре, не является структурным изменением.) Это обычно достигается синхронизацией на некотором объекте, который естественным образом инкапсулирует карту. Если такого объекта нет, карта должна быть «упакована» с помощью метода Collections.synchronizedMap. Это лучше всего делать во время создания, чтобы предотвратить случайный несинхронизированный доступ к карте:

Map m = Collections.synchronizedMap(new IdentityHashMap(...));

Итераторы, возвращаемые методом iterator коллекций, возвращаемых всеми методами «представления коллекции» этого класса, являются быстропроваливающимися: если карта структурно изменяется в любой момент после создания итератора, каким-либо способом, кроме метода remove самого итератора, итератор выбросит исключение ConcurrentModificationException. Таким образом, при одновременном изменении итератор быстро и надёжно завершает работу, а не рискует произвольным, неопределённым поведением в неопределённое время в будущем.

Обратите внимание, что поведение быстропроваливающегося итератора не гарантируется, так как в целом невозможно дать какие-либо строгие гарантии при одновременном несинхронизированном изменении. Быстропроваливающиеся итераторы выбрасывают ConcurrentModificationException по возможности. Поэтому неправильно писать программу, зависящую от этого исключения для правильности: быстропроваливающиеся итераторы должны использоваться только для обнаружения ошибок.

Примечание по реализации: это простая хеш-таблица с линейным зондированием, как описано, например, в текстах Сэджвика и Кнута. Массив чередуется, содержащий ключи и значения. (Это обеспечивает лучшую локальность для больших таблиц, чем использование отдельных массивов.) Для многих реализаций JRE и смесей операций этот класс будет обеспечивать лучшую производительность, чем HashMap (который использует цепирование, а не линейное зондирование).

Этот класс является членом Java Collections Framework.

Краткое описание конструкторов

IdentityHashMap

public IdentityHashMap()

Конструирует новый, пустой хеш-набор тождеств с размером по умолчанию (21).

IdentityHashMap

public IdentityHashMap(int expectedMaxSize)

Конструирует новую, пустую карту с указанным ожидаемым максимальным размером. Добавление большего, чем ожидаемое, количества пар «ключ-значение» в карту может привести к росту внутренней структуры данных, что может занять некоторое время.

Параметры:

expectedMaxSize - ожидаемый максимальный размер карты

Исключения:

IllegalArgumentException - если expectedMaxSize отрицательное

IdentityHashMap

public IdentityHashMap(Map<? extends K,? extends V> m)

Конструирует новый хеш-набор тождеств, содержащий сопоставления ключей-значений в указанной карте.

Параметры:

m - карта, сопоставления которой должны быть помещены в эту карту

Исключения:

NullPointerException - если указанная карта равна null

Краткое описание методов

size

public int size()

Возвращает количество сопоставлений ключ-значение в этом хеш-наборе тождеств.

Указано в:

size в интерфейсе Map<K,V>

Переопределяет:

size в классе AbstractMap<K,V>

Возвращает:

количество сопоставлений ключ-значение в этой карте

isEmpty

public boolean isEmpty()

Возвращает true если этот хеш-набор тождеств не содержит сопоставлений ключ-значение.

Указано в:

isEmpty в интерфейсе Map<K,V>

Переопределяет:

isEmpty в классе AbstractMap<K,V>

Возвращает:

true если этот хеш-набор тождеств не содержит сопоставлений ключ-значение

get

public V get(Object key)

Указано в:

get в интерфейсе Map<K,V>

Переопределяет:

get в классе AbstractMap<K,V>

Параметры:

key - ключ, связанное с которым значение должно быть возвращено

Возвращает:

значение, с которым сопоставлен указанный ключ, или null если эта карта не содержит сопоставления для ключа

См. также:

put(Object, Object)

containsKey

public boolean containsKey(Object key)

Проверяет, является ли указанный объектный указатель ключом в этом хеш-наборе тождеств.

Указано в:

containsKey в интерфейсе Map<K,V>

Переопределяет:

containsKey в классе AbstractMap<K,V>

Параметры:

key - возможный ключ

Возвращает:

true если указанный объектный указатель является ключом в этой карте

См. также:

containsValue(Object)

containsValue

public boolean containsValue(Object value)

Проверяет, является ли указанный объектный указатель значением в этом хеш-наборе тождеств.

Указано в:

containsValue в интерфейсе Map<K,V>

Переопределяет:

containsValue в классе AbstractMap<K,V>

Параметры:

value - значение, наличие которого в этой карте должно быть проверено

Возвращает:

true если эта карта сопоставляет один или несколько ключей с указанным объектным указателем

См. также:

containsKey(Object)

put

public V put(K key,
             V value)

Связывает указанное значение с указанным ключом в этом хеш-наборе тождеств. Если карта ранее содержала сопоставление для ключа, старое значение заменяется.

Указано в:

put в интерфейсе Map<K,V>

Переопределяет:

put в классе AbstractMap<K,V>

Параметры:

key - ключ, с которым должно быть связано указанное значение

value - значение, которое должно быть связано с указанным ключом

Возвращает:

предыдущее значение, связанное с key, или null если не было сопоставления для key. (Возвращение null также может указывать на то, что карта ранее связывала null с key.)

См. также:

Object.equals(Object), get(Object), containsKey(Object)

putAll

public void putAll(Map<? extends K,? extends V> m)

Копирует все сопоставления из указанной карты в эту карту. Эти сопоставления заменят любые сопоставления, которые эта карта имела для любых ключей, в настоящее время находящихся в указанной карте.

Указано в:

putAll в интерфейсе Map<K,V>

Переопределяет:

putAll в классе AbstractMap<K,V>

Параметры:

m - сопоставления, которые должны быть сохранены в этой карте

Исключения:

NullPointerException - если указанная карта равна null

remove

public V remove(Object key)

Удаляет сопоставление для этого ключа из этой карты, если оно присутствует.

Указано в:

remove в интерфейсе Map<K,V>

Переопределяет:

remove в классе AbstractMap<K,V>

Параметры:

key - ключ, сопоставление которого должно быть удалено из карты

Возвращает:

предыдущее значение, связанное с key, или null если не было сопоставления для key. (Возвращение null также может указывать на то, что карта ранее связывала null с key.)

clear

public void clear()

Удаляет все сопоставления из этой карты. Карта будет пуста после возврата этого вызова.

Указано в:

clear в интерфейсе Map<K,V>

Переопределяет:

clear в классе AbstractMap<K,V>

equals

public boolean equals(Object o)

Указано в:

equals в интерфейсе Map<K,V>

Переопределяет:

equals в классе AbstractMap<K,V>

Параметры:

o - объект, который нужно сравнить на равенство с этой картой

Возвращает:

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

См. также:

Object.equals(Object)

hashCode

public int hashCode()

Указано в:

hashCode в интерфейсе Map<K,V>

Переопределяет:

hashCode в классе AbstractMap<K,V>

Возвращает:

значение хэш-кода для этой карты

См. также:

Object.equals(Object), equals(Object)

clone

public Object clone()

Возвращает неглубокую копию этого хеш-набора тождеств: сами ключи и значения не клонируются.

Переопределяет:

clone в классе AbstractMap<K,V>

Возвращает:

неглубокая копия этой карты

См. также:

Cloneable

keySet

public Set<K> keySet()

Определено в:

keySet в интерфейсе Map<K,V>

Переопределяет:

keySet в классе AbstractMap<K,V>

Возвращает:

представление множества ключей, содержащихся в этой карте, основанное на идентичности

См. также:

Object.equals(Object), System.identityHashCode(Object)

values

public Collection<V> values()

Определено в:

values в интерфейсе Map<K,V>

Переопределяет:

values в классе AbstractMap<K,V>

Возвращает:

представление коллекции значений, содержащихся в этой карте

entrySet

public Set<Map.Entry<K,V>> entrySet()

Определено в:

entrySet в интерфейсе Map<K,V>

Определено в:

entrySet в классе AbstractMap<K,V>

Возвращает:

представление множества отображений, содержащихся в этой карте

forEach

public void forEach(BiConsumer<? super K,? super V> action)

Описание скопировано из интерфейса: Map

Выполняет заданное действие для каждой записи в этой карте до тех пор, пока все записи не будут обработаны или действие не выбросит исключение. За исключением случаев, указанных в реализующем классе, действия выполняются в порядке итерации набора записей (если порядок итерации указан.) Исключения, выброшенные действием, передаются вызывающему объекту.

Определено в:

forEach в интерфейсе Map<K,V>

Параметры:

action - действие, которое будет выполнено для каждой записи

replaceAll

public void replaceAll(BiFunction<? super K,? super V,? extends V> function)

Описание скопировано из интерфейса: Map

Заменяет значение каждой записи результатом вызова заданной функции для этой записи до тех пор, пока все записи не будут обработаны или функция не выбросит исключение. Исключения, выброшенные функцией, передаются вызывающему объекту.

Определено в:

replaceAll в интерфейсе Map<K,V>

Параметры:

function - функция, которая будет применена к каждой записи