java.util

Интерфейсная Карта <K, V>

Введите Параметры:

K - тип ключей сохраняется этой картой

V - тип отображенных значений

Все Известные Подынтерфейсы:

Привязка, ConcurrentMap <K, V>, ConcurrentNavigableMap <K, V>, LogicalMessageContext, MessageContext, NavigableMap <K, V>, SOAPMessageContext, SortedMap <K, V>

Все Известные Классы с реализацией:

AbstractMap, Атрибуты, AuthProvider, ConcurrentHashMap, ConcurrentSkipListMap, EnumMap, HashMap, Хеш-таблица, IdentityHashMap, LinkedHashMap, PrinterStateReasons, Свойства, Провайдер, RenderingHints, SimpleBindings, TabularDataSupport, TreeMap, UIDefaults, WeakHashMap

public interface Map<K,V>

Объект, который отображает ключи на значения. Карта не может содержать, делают дубликаты ключа; каждый ключ может отобразиться на самое большее одно значение.

Этот интерфейс берет место класса Dictionary, который был полностью абстрактным классом, а не интерфейсом.

Интерфейс Map обеспечивает три представления набора, которые позволяют содержанию карты просматриваться как ряд ключей, набора значений, или набора отображений значения ключа. Порядок карты определяется как порядок, в котором iterators на представлениях набора карты возвращают свои элементы. Некоторые реализации карты, как класс TreeMap, делают определенные гарантии относительно их порядка; другие, как класс HashMap, не делают.

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

Все классы реализации карты общего назначения должны предоставить двум "стандартным" конструкторам: пустота (никакие параметры) конструктор, который создает пустую карту, и конструктора с единственным параметром типа Map, который создает новую карту с теми же самыми отображениями значения ключа как его параметр. В действительности последний конструктор позволяет пользователю копировать любую карту, производя эквивалентную карту требуемого класса. Нет никакого способа осуществить эту рекомендацию (поскольку интерфейсы не могут содержать конструкторов), но все реализации карты общего назначения в JDK подчиняются.

"Разрушительные" методы, содержавшиеся в этом интерфейсе, то есть, методы, которые изменяют карту, на которой они работают, определяются, чтобы бросить UnsupportedOperationException, если эта карта не поддерживает работу. Если это верно, эти методы, но не обязаны, может бросить UnsupportedOperationException, если вызов не имел бы никакого эффекта на карту. Например, вызов putAll(Map) метод на неподдающейся изменению карте, но не обязан, может выдать исключение, если карта, отображения которой должны быть "наложены", пуста.

У некоторых реализаций карты есть ограничения на ключи и значения, которые они могут содержать. Например, некоторые реализации запрещают нулевые ключи и значения, и у некоторых есть ограничения на типы их ключей. Попытка вставить неподходящий ключ или значение выдает исключение непроверенное, обычно NullPointerException или ClassCastException. Попытка запросить присутствие неподходящего ключа или значения может выдать исключение, или это может просто возвратить false; некоторые реализации покажут прежнее поведение, и некоторые покажут последнего. Более широко попытка работы на неподходящем ключе или значении, завершение которого не привело бы к вставке неподходящего элемента в карту, может выдать исключение, или это может успешно выполниться в опции реализации. Такие исключения отмечаются как "дополнительные" в спецификации для этого интерфейса.

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

Много методов в интерфейсах Платформы Наборов определяются с точки зрения equals метод. Например, спецификация для containsKey(Object key) метод говорит: "возвраты true, если и только если эта карта содержит отображение для ключа k так, что (key==null ? k==null : key.equals(k))." Эта спецификация не должна быть рассмотрена, чтобы подразумевать, что, вызывая Map.containsKey с ненулевым параметром key заставит key.equals(k) быть вызванным для любого ключа k. Реализации свободны реализовать оптимизацию, посредством чего вызова equals избегает, например, первое сравнение хэш-кодов этих двух ключей. ( Object.hashCode() спецификация гарантирует, что два объекта с неравными хэш-кодами не могут быть равными.) Более широко реализации различных интерфейсов Платформы Наборов свободны использовать в своих интересах указанное поведение базовых Object методы везде, где конструктор считает это соответствующим.

С тех пор:

1.2

См. Также:

HashMap, TreeMap, Hashtable, SortedMap, Collection, Set

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

Вложенные Классы

Модификатор и Тип	Интерфейс и Описание
static interface	Map.Entry<K,V> Запись карты (пара ключ/значение).

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	clear() Удаляет все отображения из этой карты (дополнительная работа).
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() Возвращает значение хэш-кода для этой карты.
boolean	isEmpty() true возвратов, если эта карта не содержит отображений значения ключа.
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 представление значений содержится в этой карте.

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

размер

int size()

Возвращает число отображений значения ключа в этой карте. Если карта содержит больше чем элементы Integer.MAX_VALUE, Integer.MAX_VALUE возвратов.

Возвраты:

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

isEmpty

boolean isEmpty()

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

Возвраты:

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

containsKey

boolean containsKey(Object key)

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

Параметры:

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

Возвраты:

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

Броски:

ClassCastException - если ключ имеет несоответствующий тип для этой (дополнительной) карты

NullPointerException - если указанный ключ является нулем, и эта карта не разрешает нулевые (дополнительные) ключи

containsValue

boolean containsValue(Object value)

true возвратов, если эта карта отображает один или более ключей на указанное значение. Более формально, возвраты true, если и только если эта карта содержит по крайней мере одно отображение на значение v так, что (value==null ? v==null : value.equals(v)). Эта работа, вероятно, потребует времени, линейного в размере карты для большинства реализаций интерфейса Map.

Параметры:

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

Возвраты:

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

Броски:

ClassCastException - если значение имеет несоответствующий тип для этой (дополнительной) карты

NullPointerException - если указанное значение является нулем, и эта карта не разрешает (дополнительные) нулевые значения

добраться

V get(Object key)

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

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

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

Параметры:

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

Возвраты:

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

Броски:

ClassCastException - если ключ имеет несоответствующий тип для этой (дополнительной) карты

NullPointerException - если указанный ключ является нулем, и эта карта не разрешает нулевые (дополнительные) ключи

поместить

V put(K key,
    V value)

Связывает указанное значение с указанным ключом в этой карте (дополнительная работа). Если карта, ранее содержавшая отображение для ключа, старое значение заменяется указанным значением. (Карта m, как говорят, содержит отображение для ключа k если и только если m.containsKey(k) возвратил бы true.)

Параметры:

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

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

Возвраты:

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

Броски:

UnsupportedOperationException - если работа put не поддерживается этой картой

ClassCastException - если класс указанного ключа или значения препятствует тому, чтобы это было сохранено в этой карте

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

IllegalArgumentException - если некоторое свойство указанного ключа или значения препятствует тому, чтобы это было сохранено в этой карте

удалить

V remove(Object key)

Удаляет отображение для ключа из этой карты, если это присутствует (дополнительная работа). Более формально, если эта карта содержит отображение от ключа k, чтобы оценить v так, что (key==null ? k==null : key.equals(k)), то отображение удаляется. (Карта может содержать самое большее одно такое отображение.)

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

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

Карта не будет содержать отображение для указанного ключа, как только вызов возвращается.

Параметры:

key - манипулируйте, чье отображение должно быть удалено из карты

Возвраты:

предыдущее значение, связанное с key, или null, если не было никакого отображения для key.

Броски:

UnsupportedOperationException - если работа remove не поддерживается этой картой

ClassCastException - если ключ имеет несоответствующий тип для этой (дополнительной) карты

NullPointerException - если указанный ключ является нулем, и эта карта не разрешает нулевые (дополнительные) ключи

putAll

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

Копии все отображения от указанной карты до этой карты (дополнительная работа). Эффект этого вызова эквивалентен тому из вызова put(k, v) на этой карте однажды для каждого отображения от ключа k, чтобы оценить v в указанной карте. Поведение этой работы неопределено, если указанная карта изменяется, в то время как работа происходит.

Параметры:

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

Броски:

UnsupportedOperationException - если работа putAll не поддерживается этой картой

ClassCastException - если класс ключа или значения в указанной карте препятствует тому, чтобы это было сохранено в этой карте

NullPointerException - если указанная карта является нулем, или если эта карта не разрешает нулевые ключи или значения, и указанная карта содержит нулевые ключи или значения

IllegalArgumentException - если некоторое свойство ключа или значения в указанной карте препятствует тому, чтобы это было сохранено в этой карте

очистить

void clear()

Удаляет все отображения из этой карты (дополнительная работа). Карта будет пуста после этого вызова возвраты.

Броски:

UnsupportedOperationException - если работа clear не поддерживается этой картой

набор ключей

Set<K> keySet()

Возвраты a Set представление ключей содержится в этой карте. Набор поддерживается картой, так изменения к карте отражаются в наборе, и наоборот. Если карта изменяется, в то время как итерация по набору происходит (кроме через собственную работу remove iterator), результаты итерации неопределены. Набор поддерживает удаление элемента, которое удаляет соответствующее отображение из карты, через Iterator.remove, Set.remove, removeAll, retainAll, и операции clear. Это не поддерживает операции addAll или add.

Возвраты:

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

значения

Collection<V> values()

Возвраты a Collection представление значений содержится в этой карте. Набор поддерживается картой, так изменения к карте отражаются в наборе, и наоборот. Если карта изменяется, в то время как итерация по набору происходит (кроме через собственную работу remove iterator), результаты итерации неопределены. Набор поддерживает удаление элемента, которое удаляет соответствующее отображение из карты, через Iterator.remove, Collection.remove, removeAll, retainAll и операции clear. Это не поддерживает операции addAll или add.

Возвраты:

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

entrySet

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

Возвраты a Set представление отображений содержится в этой карте. Набор поддерживается картой, так изменения к карте отражаются в наборе, и наоборот. Если карта изменяется, в то время как итерация по набору происходит (кроме через собственную работу remove iterator, или через работу setValue на записи карты, возвращенной iterator), результаты итерации неопределены. Набор поддерживает удаление элемента, которое удаляет соответствующее отображение из карты, через Iterator.remove, Set.remove, removeAll, retainAll и операции clear. Это не поддерживает операции addAll или add.

Возвраты:

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

равняется

boolean equals(Object o)

Сравнивает указанный объект с этой картой для равенства. Возвраты true, если данный объект является также картой и двумя картами, представляют те же самые отображения. Более формально две карты m1 и m2 представляют те же самые отображения если m1.entrySet().equals(m2.entrySet()). Это гарантирует, что метод equals работает должным образом через различные реализации интерфейса Map.

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

equals в классе Object

Параметры:

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

Возвраты:

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

См. Также:

Object.hashCode(), HashMap

хэш-код

int hashCode()

Возвращает значение хэш-кода для этой карты. Хэш-код карты определяется, чтобы быть суммой хэш-кодов каждой записи в представлении entrySet() карты. Это гарантирует, что m1.equals(m2) подразумевает что m1.hashCode()==m2.hashCode() для любых двух карт m1 и m2, как требуется согласно общему контракту Object.hashCode().

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

hashCode в классе Object

Возвраты:

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

См. Также:

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