Класс WeakHashMap<K,V>

Поддерживаются как значения 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.