Класс EnumMap<K extends Enum<K>, V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.EnumMap<K,V>

Type Parameters:: K - тип перечисления ключей, поддерживаемых этим отображением; V - тип сопоставленных значений

Все реализуемые интерфейсы:: Serializable, Cloneable, Map<K,V>

public class EnumMap<K extends Enum<K>, V> extends AbstractMap<K,V> implements Serializable, Cloneable

Специализированная реализация Map для использования с ключами типа перечисления. Все ключи в отображении перечислений должны происходить из одного типа перечисления, который задаётся явно или неявно при создании отображения. Отображения перечислений представлены внутри как массивы. Это представление чрезвычайно компактное и эффективное.

Отображения перечислений сохраняются в естественном порядке своих ключей (порядке, в котором объявлены константы перечисления). Это отражается в итераторах, возвращаемых представлениями коллекций (keySet(), entrySet() и values()).

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

Ключи со значением null запрещены. Попытки вставить ключ со значением null выбросят NullPointerException. Однако попытки проверки наличия ключа со значением null или удаления его будут работать должным образом. Значения со значением null разрешены.

Как и большинство реализаций коллекций, EnumMap не синхронизирована. Если несколько потоков обращаются к отображению перечислений одновременно, и по меньшей мере один из потоков изменяет отображение, оно должно быть синхронизировано внешне. Это обычно достигается путём синхронизации на каком-либо объекте, который естественным образом инкапсулирует отображение перечислений. Если такого объекта нет, отображение должно быть «оборачено» с помощью метода Collections.synchronizedMap(java.util.Map<K, V>). Это лучше всего сделать на этапе создания, чтобы предотвратить случайный несинхронизированный доступ:

     Map<EnumKey, V> m
         = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...));

Примечание реализации: все базовые операции выполняются за константное время. Они, вероятно (хотя и не гарантировано), будут быстрее, чем их аналоги из HashMap.

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

Since:

1.5

См. также:

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в классе java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Вложенные классы/интерфейсы, объявленные в интерфейсе java.util.Map

Map.Entry<K,V>

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

Конструктор	Описание
`EnumMap(Class<K> keyType)`	Создаёт пустое отображение перечислений с указанным типом ключа.
`EnumMap(EnumMap<K, ? extends V> m)`	Создаёт отображение перечислений с тем же типом ключа, что и указанное отображение перечислений, содержащее первоначально те же сопоставления (если таковые имеются).
`EnumMap(Map<K, ? extends V> m)`	Создаёт отображение перечислений, инициализированное из указанного отображения.

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

Модификатор и тип	Метод	Описание
`void`	`clear()`	Удаляет все сопоставления из этого отображения.
`EnumMap<K,V>`	`clone()`	Возвращает неглубокую копию этого отображения перечислений.
`boolean`	`containsKey(Object key)`	Возвращает `true`, если это отображение содержит сопоставление для указанного ключа.
`boolean`	`containsValue(Object value)`	Возвращает `true`, если это отображение сопоставляет один или несколько ключей со значением.
`Set<Map.Entry<K,V>>`	`entrySet()`	Возвращает `Set` представление сопоставлений, содержащихся в этом отображении.
`boolean`	`equals(Object o)`	Сравнивает указанный объект с этим отображением для равенства.
`V`	`get(Object key)`	Возвращает значение, которому сопоставлен указанный ключ, или `null`, если это отображение не содержит сопоставления для ключа.
`int`	`hashCode()`	Возвращает хэш-код для этого отображения.
`Set<K>`	`keySet()`	Возвращает `Set` представление ключей, содержащихся в этом отображении.
`V`	`put(K key, V value)`	Сопоставляет указанное значение с указанным ключом в этом отображении.
`void`	`putAll(Map<? extends K, ? extends V> m)`	Копирует все сопоставления из указанного отображения в это отображение.
`V`	`remove(Object key)`	Удаляет сопоставление для этого ключа из этого отображения, если оно присутствует.
`int`	`size()`	Возвращает количество пар ключ-значение в этом отображении.
`Collection<V>`	`values()`	Возвращает `Collection` представление значений, содержащихся в этом отображении.

Методы, объявленные в классе java.util.AbstractMap

isEmpty, toString

Методы, объявленные в классе java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Подробное описание конструкторов

EnumMap

public EnumMap(Class<K> keyType)

Создаёт пустую карту перечислений с указанным типом ключей.

Параметры:: keyType - объект класса типа ключа для этой карты перечислений
Исключения:: NullPointerException - если keyType равно null

EnumMap

public EnumMap(EnumMap<K, ? extends V> m)

Создаёт карту перечислений с тем же типом ключей, что и указанная карта перечислений, изначально содержащую те же сопоставления (если таковые имеются).

Параметры:: m - карта перечислений, из которой следует инициализировать эту карту перечислений
Исключения:: NullPointerException - если m равно null

EnumMap

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

Создаёт карту перечислений, инициализированную из указанной карты. Если указанная карта является экземпляром EnumMap, этот конструктор ведет себя идентично EnumMap(EnumMap). В противном случае, указанная карта должна содержать по крайней мере одно сопоставление (для определения типа ключа новой карты перечислений).

Параметры:: m - карта, из которой следует инициализировать эту карту перечислений
Исключения:: IllegalArgumentException - если m не является экземпляром EnumMap и не содержит сопоставлений; NullPointerException - если m равно null

Подробное описание методов

size

public int size()

Возвращает количество пар «ключ-значение» в этой карте.

Унаследовано от:: size в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: size в классе AbstractMap<K extends Enum<K>, V>
Возвращает:: количество пар «ключ-значение» в этой карте

containsValue

public boolean containsValue(Object value)

Возвращает true, если эта карта сопоставляет один или несколько ключей со значением.

Унаследовано от:: containsValue в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: containsValue в классе AbstractMap<K extends Enum<K>, V>
Параметры:: value - значение, чьё наличие в этой карте должно быть проверено
Возвращает:: true, если эта карта сопоставляет один или несколько ключей с этим значением

containsKey

public boolean containsKey(Object key)

Возвращает true, если эта карта содержит сопоставление для указанного ключа.

Унаследовано от:: containsKey в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: containsKey в классе AbstractMap<K extends Enum<K>, V>
Параметры:: key - ключ, чьё наличие в этой карте должно быть проверено
Возвращает:: true, если эта карта содержит сопоставление для указанного ключа

get

public V get(Object key)

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

Более формально, если эта карта содержит сопоставление от ключа k к значению v такое, что (key == k), то этот метод возвращает v; в противном случае он возвращает null. (Может быть не более одного такого сопоставления.)

Возврат значения null не обязательно указывает на то, что карта не содержит сопоставления для ключа; также возможно, что карта явно сопоставляет ключ со значением null. Операция containsKey может быть использована для различения этих двух случаев.

Унаследовано от:: get в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: get в классе AbstractMap<K extends Enum<K>, V>
Параметры:: key - ключ, связанное значение которого должно быть возвращено
Возвращает:: значение, которому сопоставлен указанный ключ, или null, если в этой карте нет сопоставления для ключа

put

public V put(K key, V value)

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

Унаследовано от:: put в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: put в классе AbstractMap<K extends Enum<K>, V>
Параметры:: key - ключ, с которым должно быть связано указанное значение; value - значение, которое должно быть связано с указанным ключом
Возвращает:: предыдущее значение, связанное с указанным ключом, или null, если для ключа не было сопоставления. (Возврат null также может указывать на то, что карта ранее связывала null с указанным ключом.)
Исключения:: NullPointerException - если указанный ключ равен null

remove

public V remove(Object key)

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

Унаследовано от:: remove в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: remove в классе AbstractMap<K extends Enum<K>, V>
Параметры:: key - ключ, чьё сопоставление должно быть удалено из карты
Возвращает:: предыдущее значение, связанное с указанным ключом, или null, если для ключа не было записи. (Возврат null также может указывать на то, что карта ранее связывала null с указанным ключом.)

putAll

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

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

Унаследовано от:: putAll в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: putAll в классе AbstractMap<K extends Enum<K>, V>
Параметры:: m - сопоставления, которые должны быть сохранены в этой карте
Исключения:: NullPointerException - указанная карта равна null, или один или несколько ключей в указанной карте равны null

clear

public void clear()

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

Унаследовано от:: clear в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: clear в классе AbstractMap<K extends Enum<K>, V>

keySet

public Set<K> keySet()

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

Унаследовано от:: keySet в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: keySet в классе AbstractMap<K extends Enum<K>, V>
Возвращает:: представление набора ключей, содержащихся в этой карте перечислений

values

public Collection<V> values()

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

Унаследовано от:: values в интерфейсе Map<K extends Enum<K>, V>
Переопределяет:: values в классе AbstractMap<K extends Enum<K>, V>
Возвращает:: представление коллекции значений, содержащихся в этой карте

entrySet

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

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

Унаследовано от:: entrySet в интерфейсе Map<K extends Enum<K>, V>
Возвращает:: представление набора сопоставлений, содержащихся в этой карте перечислений

equals

public boolean equals(Object o)

Сравнивает указанный объект с этой картой на равенство. Возвращает true, если заданный объект также является картой, и две карты представляют те же сопоставления, как указано в контракте Map.equals(Object).

Specified by:

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

Overrides:

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

Parameters:

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

Returns:

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

See Also:

hashCode

public int hashCode()

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

Specified by:

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

Overrides:

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

Returns:

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

See Also:

clone

public EnumMap<K,V> clone()

Возвращает поверхностную копию этой карты перечислений. Сами значения не клонируются.

Overrides:

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

Returns:

поверхностную копию этой карты перечислений

See Also:

© 1993, 2025, 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/util/EnumMap.html