Интерфейс ConcurrentMap<K,V>

A Map обеспечивающая безопасность потоков и гарантии атомности.

Влияние согласованности памяти: Как и в других коллекциях с одновременным доступом, действия в потоке до помещения объекта в ConcurrentMap в качестве ключа или значения предшествуют действиям, последующим за доступом или удалением этого объекта из ConcurrentMap в другом потоке.

Этот интерфейс является членом Java Collections Framework.

Методы

getOrDefault

default V getOrDefault(Object key,
                       V defaultValue)

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

Указано в:

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

Примечание реализации:

Эта реализация предполагает, что ConcurrentMap не может содержать null-значений и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают null-значения, должны переопределить эту реализацию по умолчанию.

Параметры:

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

defaultValue - значение по умолчанию для ключа

Возвращает:

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

Исключение:

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

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

С:

1.8

forEach

default void forEach(BiConsumer<? super K,? super V> action)

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

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна, для этой map:

for ((Map.Entry<K, V> entry : map.entrySet())
     action.accept(entry.getKey(), entry.getValue());

Примечание реализации:

Реализация по умолчанию предполагает, что IllegalStateException выброшенное getKey() или getValue() указывает, что запись была удалена и не может быть обработана. Обработка продолжается для последующих записей.

Параметры:

action - действие, которое должно выполняться для каждой записи

Исключение:

NullPointerException - если указанное действие равно null

С:

1.8

putIfAbsent

V putIfAbsent(K key,
              V value)

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

if (!map.containsKey(key))
   return map.put(key, value);
 else
   return map.get(key);

Указано в:

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

Примечание реализации:

Эта реализация преднамеренно повторно абстрагирует неподходящую реализацию по умолчанию, предоставленную в Map.

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

NullPointerException - если указанный ключ или значение равно null, а эта карта не допускает null-ключей или -значений

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

remove

boolean remove(Object key,
               Object value)

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

if (map.containsKey(key) && Objects.equals(map.get(key), value)) {
   map.remove(key);
   return true;
 } else
   return false;

Указано в:

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

Примечание реализации:

Эта реализация преднамеренно повторно абстрагирует неподходящую реализацию по умолчанию, предоставленную в Map.

Параметры:

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

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

Возвращает:

true если значение было удалено

Исключение:

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

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

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

replace

boolean replace(K key,
                V oldValue,
                V newValue)

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

if (map.containsKey(key) && Objects.equals(map.get(key), oldValue)) {
   map.put(key, newValue);
   return true;
 } else
   return false;

Указано в:

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

Примечание реализации:

Эта реализация преднамеренно повторно абстрагирует неподходящую реализацию по умолчанию, предоставленную в Map.

Параметры:

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

oldValue - ожидаемое значение, связанное с указанным ключом

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

Возвращает:

true если значение было заменено

Исключение:

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

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

NullPointerException - если указанный ключ или значение равно null, а эта карта не допускает null-ключей или -значений

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

replace

V replace(K key,
          V value)

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

if (map.containsKey(key)) {
   return map.put(key, value);
 } else
   return null;

Указано в:

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

Примечание реализации:

Эта реализация преднамеренно повторно абстрагирует неподходящую реализацию по умолчанию, предоставленную в Map.

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

NullPointerException - если указанный ключ или значение равно null, а эта карта не допускает null-ключей или -значений

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

replaceAll

default void replaceAll(BiFunction<? super K,? super V,? extends V> function)

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

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна, для этой map:

for ((Map.Entry<K, V> entry : map.entrySet())
     do {
        K k = entry.getKey();
        V v = entry.getValue();
     } while(!replace(k, v, function.apply(k, v)));

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

Эта реализация предполагает, что ConcurrentMap не может содержать null-значений и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают null-значения, должны переопределить эту реализацию по умолчанию.

Параметры:

function - функция, применяемая к каждой записи

Исключение:

UnsupportedOperationException - если операция set не поддерживается итератором набора записей этой карты.

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

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

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

С:

1.8

computeIfAbsent

default V computeIfAbsent(K key,
                          Function<? super K,? extends V> mappingFunction)

map.computeIfAbsent(key, k -> new Value(f(k)));

map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна следующим шагам для этого map, затем возвращает текущее значение или null если его сейчас нет:

if (map.get(key) == null) {
     V newValue = mappingFunction.apply(key);
     if (newValue != null)
         return map.putIfAbsent(key, newValue);
 }

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

Эта реализация предполагает, что ConcurrentMap не может содержать нулевые значения и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают нулевые значения, обязаны переопределить эту реализацию по умолчанию.

Параметры:

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

mappingFunction - функция для вычисления значения

Возвращает:

текущее (существующее или вычисленное) значение, связанное с указанным ключом, или null, если вычисленное значение равно null

Выбрасывает:

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

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

NullPointerException - если указанный ключ равен null, и эта карта не поддерживает нулевые ключи, или функция mappingFunction равна null

С момента:

1.8

computeIfPresent

default V computeIfPresent(K key,
                           BiFunction<? super K,? super V,? extends V> remappingFunction)

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна выполнению следующих шагов для этого map, затем возвращает текущее значение или null если его сейчас нет. :

if (map.get(key) != null) {
     V oldValue = map.get(key);
     V newValue = remappingFunction.apply(key, oldValue);
     if (newValue != null)
         map.replace(key, oldValue, newValue);
     else
         map.remove(key, oldValue);
 }

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

Эта реализация предполагает, что ConcurrentMap не может содержать нулевые значения и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают нулевые значения, обязаны переопределить эту реализацию по умолчанию.

Параметры:

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

remappingFunction - функция для вычисления значения

Возвращает:

новое значение, связанное с указанным ключом, или null, если такого нет

Выбрасывает:

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

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

NullPointerException - если указанный ключ равен null, и эта карта не поддерживает нулевые ключи, или функция remappingFunction равна null

С момента:

1.8

compute

default V compute(K key,
                  BiFunction<? super K,? super V,? extends V> remappingFunction)

map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна выполнению следующих шагов для этого map, затем возвращает текущее значение или null если отсутствует:

V oldValue = map.get(key);
 V newValue = remappingFunction.apply(key, oldValue);
 if (oldValue != null ) {
    if (newValue != null)
       map.replace(key, oldValue, newValue);
    else
       map.remove(key, oldValue);
 } else {
    if (newValue != null)
       map.putIfAbsent(key, newValue);
    else
       return null;
 }

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

Эта реализация предполагает, что ConcurrentMap не может содержать нулевые значения и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают нулевые значения, обязаны переопределить эту реализацию по умолчанию.

Параметры:

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

remappingFunction - функция для вычисления значения

Возвращает:

новое значение, связанное с указанным ключом, или null, если такого нет

Выбрасывает:

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

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

NullPointerException - если указанный ключ равен null, и эта карта не поддерживает нулевые ключи, или функция remappingFunction равна null

С момента:

1.8

merge

default V merge(K key,
                V value,
                BiFunction<? super V,? super V,? extends V> remappingFunction)

map.merge(key, msg, String::concat)

Указано в:

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

Требования к реализации:

Реализация по умолчанию эквивалентна выполнению следующих шагов для этого map, затем возвращает текущее значение или null если отсутствует:

V oldValue = map.get(key);
 V newValue = (oldValue == null) ? value :
              remappingFunction.apply(oldValue, value);
 if (newValue == null)
     map.remove(key);
 else
     map.put(key, newValue);

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

Эта реализация предполагает, что ConcurrentMap не может содержать нулевые значения и get() возвращение null однозначно означает, что ключ отсутствует. Реализации, которые поддерживают нулевые значения, обязаны переопределить эту реализацию по умолчанию.

Параметры:

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

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

remappingFunction - функция для повторного вычисления значения, если оно присутствует

Возвращает:

новое значение, связанное с указанным ключом, или null, если значение не связано с ключом

Выбрасывает:

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

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

NullPointerException - если указанный ключ равен null, и эта карта не поддерживает нулевые ключи, или значение или remappingFunction равно null

С момента:

1.8