Класс WeakHashMap<K,V>

Поддерживаются как нулевые значения, так и нулевой ключ. Этот класс обладает характеристиками производительности, сходными с характеристиками класса 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 коллекций, полученных с помощью всех «методов представления коллекций» этого класса, являются fail-fast: если после создания итератора структура карты изменится каким-либо образом, кроме вызова собственного метода remove итератора, итератор выбросит исключение ConcurrentModificationException. Таким образом, при параллельном изменении итератор быстро и корректно завершается с ошибкой, а не подвергается риску произвольного, недетерминированного поведения в неопределённый момент в будущем.

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

Этот класс входит в состав Java Collections Framework.