java.util

Класс AbstractMap <K, V>

java.lang. Объект

java.util. AbstractMap <K, V>

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

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

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

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

Карта <K, V>

Прямые Известные Подклассы:

ConcurrentHashMap, ConcurrentSkipListMap, EnumMap, HashMap, IdentityHashMap, TreeMap, WeakHashMap

public abstract class AbstractMap<K,V>
extends Object
implements Map<K,V>

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

Чтобы реализовать неподдающуюся изменению карту, программист должен только расширить этот класс и обеспечить реализацию для метода entrySet, который возвращает представление набора отображений карты. Как правило, возвращенный набор будет, поочередно, реализован на AbstractSet. Этот набор не должен поддерживать методы add ИЛИ remove, и его iterator не должен поддерживать метод remove.

Чтобы реализовать поддающуюся изменению карту, программист должен дополнительно переопределить метод put этого класса (который иначе бросает UnsupportedOperationException), и iterator, возвращенный entrySet().iterator(), должен дополнительно реализовать свой метод remove.

Программист должен обычно обеспечить пустоту (никакой параметр) и отобразить конструктора согласно рекомендации в спецификации интерфейса Map.

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

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

С тех пор:

1.2

См. Также:

Map, Collection

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

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

Модификатор и Тип	Класс и Описание
static class	AbstractMap.SimpleEntry<K,V> Запись, поддерживающая ключ и значение.
static class	AbstractMap.SimpleImmutableEntry<K,V> Запись, поддерживающая неизменный ключ и значение.

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

Map.Entry<K,V>

Сводка конструктора

Конструкторы

Модификатор	Конструктор и Описание
protected	AbstractMap() Единственный конструктор.

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

Методы

Модификатор и Тип	Метод и Описание
void	clear() Удаляет все отображения из этой карты (дополнительная работа).
protected Object	clone() Возвращает мелкую копию этого экземпляра AbstractMap: ключи и сами значения не клонируются.
boolean	containsKey(Object key) true возвратов, если эта карта содержит отображение для указанного ключа.
boolean	containsValue(Object value) true возвратов, если эта карта отображает один или более ключей на указанное значение.
abstract 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() Возвращает число отображений значения ключа в этой карте.
Строка	toString() Возвращает строковое представление этой карты.
Collection<V>	values() Возвраты a Collection представление значений содержится в этой карте.

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

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

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

AbstractMap

protected AbstractMap()

Единственный конструктор. (Для вызова конструкторами подкласса, обычно неявными.)

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

размер

public int size()

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

Эта реализация возвращает entrySet().size().

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

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

Возвраты:

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

isEmpty

public boolean isEmpty()

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

Эта реализация возвращает size() == 0.

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

isEmpty в интерфейсе Map<K,V>

Возвраты:

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

containsValue

public boolean containsValue(Object value)

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

Эта реализация выполняет итерации по entrySet(), ищущему запись с указанным значением. Если такая запись находится, true возвращается. Если итерация завершается, не находя такую запись, false возвращается. Отметьте, что эта реализация требует линейного времени в размере карты.

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

containsKey

public boolean containsKey(Object key)

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

Эта реализация выполняет итерации по entrySet(), ищущему запись с указанным ключом. Если такая запись находится, true возвращается. Если итерация завершается, не находя такую запись, false возвращается. Отметьте, что эта реализация требует линейного времени в размере карты; много реализаций переопределят этот метод.

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

добраться

public V get(Object key)

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

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

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

Эта реализация выполняет итерации по entrySet(), ищущему запись с указанным ключом. Если такая запись находится, значение записи возвращается. Если итерация завершается, не находя такую запись, null возвращается. Отметьте, что эта реализация требует линейного времени в размере карты; много реализаций переопределят этот метод.

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

поместить

public V put(K key,
    V value)

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

Эта реализация всегда бросает UnsupportedOperationException.

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

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

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

удалить

public V remove(Object key)

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

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

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

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

Эта реализация выполняет итерации по entrySet(), ищущему запись с указанным ключом. Если такая запись находится, ее значение получается с ее работой getValue, запись удаляется из набора (и отступающая карта) с работой remove iterator, и сохраненное значение возвращается. Если итерация завершается, не находя такую запись, null возвращается. Отметьте, что эта реализация требует линейного времени в размере карты; много реализаций переопределят этот метод.

Отметьте, что эта реализация бросает UnsupportedOperationException, если entrySet iterator не поддерживает метод remove, и эта карта содержит отображение для указанного ключа.

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

putAll

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

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

Эта реализация выполняет итерации по набору entrySet() указанной карты, и вызывает работу put этой карты однажды для каждой записи, возвращенной итерацией.

Отметьте, что эта реализация бросает UnsupportedOperationException, если эта карта не поддерживает работу put, и указанная карта непуста.

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

putAll в интерфейсе Map<K,V>

Параметры:

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

Броски:

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

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

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

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

очистить

public void clear()

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

Эта реализация вызывает entrySet().clear().

Отметьте, что эта реализация бросает UnsupportedOperationException, если entrySet не поддерживает работу clear.

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

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

Броски:

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

набор ключей

public Set<K> keySet()

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

Эта реализация возвращает набор, который разделяет на подклассы AbstractSet. iterator метод подкласса возвращает "объект обертки" по entrySet() этой карты iterator. Метод size делегирует к методу size этой карты и делегатам метода contains в методе containsKey этой карты.

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

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

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

Возвраты:

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

значения

public Collection<V> values()

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

Эта реализация возвращает набор, который разделяет на подклассы AbstractCollection. iterator метод подкласса возвращает "объект обертки" по entrySet() этой карты iterator. Метод size делегирует к методу size этой карты и делегатам метода contains в методе containsValue этой карты.

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

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

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

Возвраты:

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

entrySet

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

Описание скопировало с интерфейса: Map

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

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

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

Возвраты:

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

равняется

public boolean equals(Object o)

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

Эта реализация сначала проверяет, является ли указанный объект этой картой; раз так это возвращает true. Затем, это проверяет, является ли указанный объект картой, размер которой идентичен размеру этой карты; в противном случае это возвращает false. Если так, это выполняет итерации по набору entrySet этой карты, и проверяет, что указанная карта содержит каждое отображение, которое содержит эта карта. Если указанная карта не в состоянии содержать такое отображение, false возвращается. Если итерация завершается, true возвращается.

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

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

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

equals в классе Object

Параметры:

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

Возвраты:

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

См. Также:

Object.hashCode(), HashMap

хэш-код

public int hashCode()

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

Эта реализация выполняет итерации по entrySet(), вызывая hashCode() на каждом элементе (запись) в наборе, и сложение результатов.

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

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

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

hashCode в классе Object

Возвраты:

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

См. Также:

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

toString

public String toString()

Возвращает строковое представление этой карты. Строковое представление состоит из списка отображений значения ключа в порядке, возвращенном iterator представления entrySet карты, включенным в фигурные скобки ("{}"). Смежные отображения разделяются символами ", " (запятая и пространство). Каждое отображение значения ключа представляется, поскольку ключ, сопровождаемый, равняется знаку ("="), сопровождаемый присваиваемым значением. Ключи и значения преобразовываются в строки как String.valueOf(Object).

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

toString в классе Object

Возвраты:

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

клон

protected Object clone()
                throws CloneNotSupportedException

Возвращает мелкую копию этого экземпляра AbstractMap: ключи и сами значения не клонируются.

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

clone в классе Object

Возвраты:

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

Броски:

CloneNotSupportedException - если класс объекта не поддерживает Cloneable интерфейс. Подклассы, которые переопределяют clone метод может также выдать это исключение, чтобы указать, что экземпляр не может быть клонирован.

См. Также:

Cloneable