compact1, compact2, compact3

java.util

Класс EnumMap <K расширяет Перечисление <K>, V>

java.lang. Объект

java.util. AbstractMap<K, V>

java.util. EnumMap <K, V>

Все Реализованные Интерфейсы:

Сериализуемый, Cloneable, Карта <K, V>

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

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

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

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

Нулевые ключи не разрешаются. Попытки вставить нулевой ключ бросят NullPointerException. Попытки протестировать на присутствие нулевого ключа или удалить каждый будет, однако, функционировать должным образом. Нулевые значения разрешаются.

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

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

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

Этот class является элементом Платформы Наборов Java.

С тех пор:

1.5

См. Также:

EnumSet, Сериализированная Форма

Вложенная Сводка Класса

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

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

Вложенные классы/интерфейсы, наследованные от интерфейса java.util. Карта

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() Возвраты a Set представление отображений содержится в этой карте.
boolean	equals(Object o) Сравнивает указанный объект с этой картой для равенства.
V	get(Object key) Возвращает значение, на которое указанный ключ отображается, или null если эта карта не содержит отображения для ключа.
int	hashCode() Возвращает значение хэш-кода для этой карты.
Set<K>	keySet() Возвраты a Set представление ключей содержится в этой карте.
V	put(K key, V value) Связывает указанное значение с указанным ключом в этой карте.
void	putAll(Map<? extends K,? extends V> m) Копии все отображения от указанной карты до этой карты.
V	remove(Object key) Удаляет отображение для этого ключа из этой карты если существующий.
int	size() Возвращает число отображений значения ключа в этой карте.
Collection<V>	values() Возвраты a Collection представление значений содержится в этой карте.

Методы, наследованные от class java.util. AbstractMap

isEmpty, toString

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

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

Методы, наследованные от интерфейса java.util. Карта

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

Деталь конструктора

EnumMap

public EnumMap(Class<K> keyType)

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

Параметры:

keyType - объект class ключевого типа для этой перечислимой карты

Броски:

NullPointerException - если keyType является нулем

EnumMap

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

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

Параметры:

m - перечислимая карта, из которой можно инициализировать эту перечислимую карту

Броски:

NullPointerException - если m является нулем

EnumMap

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

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

Параметры:

m - карта, из которой можно инициализировать эту перечислимую карту

Броски:

IllegalArgumentException - если m не является экземпляром EnumMap и не содержит отображений

NullPointerException - если m является нулем

Деталь метода

размер

public int size()

Возвращает число отображений значения ключа в этой карте.

Определенный:

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

Переопределения:

size в class AbstractMap<K extends Enum<K>,V>

Возвраты:

число отображений значения ключа в этой карте

containsValue

public boolean containsValue(Object value)

true возвратов, если эта карта отображает один или более ключей на указанное значение.

Определенный:

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

Переопределения:

containsValue в class AbstractMap<K extends Enum<K>,V>

Параметры:

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

Возвраты:

true, если эта карта отображает один или более ключей на это значение

containsKey

public boolean containsKey(Object key)

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

Определенный:

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

Переопределения:

containsKey в class AbstractMap<K extends Enum<K>,V>

Параметры:

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

Возвраты:

true, если эта карта содержит отображение для указанного ключа

добраться

public V get(Object key)

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

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

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

Определенный:

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

Переопределения:

get в class AbstractMap<K extends Enum<K>,V>

Параметры:

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

Возвраты:

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

поместить

public V put(K key,
             V value)

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

Определенный:

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

Переопределения:

put в class AbstractMap<K extends Enum<K>,V>

Параметры:

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

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

Возвраты:

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

Броски:

NullPointerException - если указанный ключ является нулем

удалить

public V remove(Object key)

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

Определенный:

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

Переопределения:

remove в class 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 в class AbstractMap<K extends Enum<K>,V>

Параметры:

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

Броски:

NullPointerException - указанная карта является нулем, или если один или более ключей в указанной карте являются нулем

очистить

public void clear()

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

Определенный:

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

Переопределения:

clear в class AbstractMap<K extends Enum<K>,V>

набор ключей

public Set<K> keySet()

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

Определенный:

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

Переопределения:

keySet в class AbstractMap<K extends Enum<K>,V>

Возвраты:

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

значения

public Collection<V> values()

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

Определенный:

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

Переопределения:

values в class AbstractMap<K extends Enum<K>,V>

Возвраты:

представление набора значений содержится в этой карте

entrySet

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

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

Определенный:

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

Определенный:

entrySet в class AbstractMap<K extends Enum<K>,V>

Возвраты:

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

равняется

public boolean equals(Object o)

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

Определенный:

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

Переопределения:

equals в class AbstractMap<K extends Enum<K>,V>

Параметры:

o - объект, который будет сравнен для равенства с этой картой

Возвраты:

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

См. Также:

Object.hashCode(), HashMap

хэш-код

public int hashCode()

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

Определенный:

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

Переопределения:

hashCode в class AbstractMap<K extends Enum<K>,V>

Возвраты:

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

См. Также:

Map.Entry.hashCode(), Object.equals(Object), Set.equals(Object)

клон

public EnumMap<K,V> clone()

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

Переопределения:

clone в class AbstractMap<K extends Enum<K>,V>

Возвраты:

мелкая копия этой перечислимой карты

См. Также:

Cloneable