Класс WeakHashMap<K,​V>

public class WeakHashMap<K,V>
extends AbstractMap<K,​V>
implements Map<K,​V>

Реализация интерфейса Map на основе хеш-таблицы со слабыми ключами. Элемент в WeakHashMap будет автоматически удалён, когда его ключ больше не используется в обычном режиме. Точнее, наличие сопоставления для данного ключа не помешает сборщику мусора отбросить ключ, то есть сделать его финализуемым, финализировать его и затем вернуть. Когда ключ был отброшен, его запись фактически удаляется из карты, поэтому этот класс ведет себя несколько иначе, чем другие реализации Map.

Поддерживаются как значения null, так и null-ключ. Этот класс имеет характеристики производительности, аналогичные классу HashMap, и имеет те же параметры эффективности: начальную емкость и коэффициент загрузки.

Как и большинство коллекций, этот класс не синхронизирован. Синхронизированная WeakHashMap может быть создана с помощью метода Collections.synchronizedMap.

Этот класс предназначен в первую очередь для использования с объектами ключей, чьи методы equals проверяют тождественность объектов с использованием оператора ==. После того, как такой ключ будет отброшен, он никогда не сможет быть воссоздан, поэтому невозможно выполнить поиск этого ключа в WeakHashMap в какой-то момент позже и быть удивлённым, что его запись была удалена. Этот класс будет работать безупречно с объектами ключей, чьи методы equals не основаны на тождественности объектов, таких как экземпляры String. Однако с такими воссоздаваемыми объектами ключей автоматическое удаление WeakHashMap записей, ключи которых были отброшены, может оказаться запутанным.

Поведение класса WeakHashMap частично зависит от действий сборщика мусора, поэтому несколько известных (хотя и не обязательных) Map инвариантов не действуют для этого класса. Поскольку сборщик мусора может отбрасывать ключи в любое время, WeakHashMap может вести себя так, как будто неизвестная нить молча удаляет записи. В частности, даже если вы синхронизируетесь на экземпляре WeakHashMap и не вызываете ни один из его методов-мутаторов, метод size может возвращать меньшие значения со временем, метод isEmpty может возвращать false и затем true, метод containsKey может возвращать true и позже false для данного ключа, метод get может возвращать значение для данного ключа, а затем возвращать null, метод put может возвращать null, а метод remove может возвращать false для ключа, который ранее, казалось, был в карте, и последовательные проверки набора ключей, коллекции значений и набора записей могут приводить к последовательно меньшим числам элементов.

Каждый объект ключа в WeakHashMap хранится косвенно как референт слабой ссылки. Таким образом, ключ будет автоматически удалён только после того, как слабые ссылки на него, как внутри, так и вне карты, будут очищены сборщиком мусора.

Примечание к реализации: объекты значений в WeakHashMap хранятся с обычными сильными ссылками. Поэтому следует позаботиться о том, чтобы объекты значений не ссылались на свои ключи напрямую или косвенно, так как это предотвратит отбрасывание ключей. Обратите внимание, что объект значения может косвенно ссылаться на свой ключ через саму WeakHashMap; то есть, объект значения может сильно ссылаться на какой-либо другой объект ключа, связанное значение объекта которого, в свою очередь, сильно ссылается на ключ первого объекта значения. Если значения в карте не полагаются на карту, которая держит сильные ссылки на них, один из способов решения этой проблемы — обернуть сами значения в WeakReferences перед вставкой, как в: m.put(key, new WeakReference(value)), а затем распаковать при каждом get.

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

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

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