java.util.concurrent
インタフェース ConcurrentMap<K,V>

型パラメータ:

K - このマップで保持されるキーの型

V - マップされる値の型

すべてのスーパーインタフェース:

Map<K,V>

既知のサブインタフェースの一覧:

ConcurrentNavigableMap<K,V>

既知の実装クラスの一覧:

ConcurrentHashMap, ConcurrentSkipListMap

public interface ConcurrentMap<K,V>
extends Map<K,V>

追加の原子的 putIfAbsent、remove、および replace メソッドを提供する Map です。

メモリー整合性効果:ほかの並行処理コレクションと同様、オブジェクトをキーまたは値として ConcurrentMap に配置する前のスレッド内のアクションは、別のスレッドでのそのオブジェクトへのアクセスまたは ConcurrentMap からの削除に続くアクションよりも「前に発生」します。

このインタフェースは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.5

入れ子のクラスの概要

インタフェース java.util.Map から継承された入れ子のクラス/インタフェース

Map.Entry<K,V>

メソッドの概要

V	putIfAbsent(K key, V value) 指定されたキーがまだ値と関連付けられていない場合は、指定された値に関連付けます。
boolean	remove(Object key, Object value) 指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを削除します。
V	replace(K key, V value) キーが値に現在マッピングされている場合にのみ、そのキーのエントリを置換します。
boolean	replace(K key, V oldValue, V newValue) 指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを置換します。

インタフェース java.util.Map から継承されたメソッド

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

メソッドの詳細

putIfAbsent

V putIfAbsent(K key,
              V value)

指定されたキーがまだ値と関連付けられていない場合は、指定された値に関連付けます。これは次の記述と同等です。

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

ただし、アクションが原子的に実行される点が異なります。

パラメータ:

key - 指定された値が関連付けられるキー

value - 指定されたキーに関連付けられる値

戻り値:

指定されたキーに関連付けられた以前の値。キーのマッピングがなかった場合は null。また、実装が null 値をサポートしている場合、戻り値 null は、以前にマップでキーと null が関連付けられていたことを示す場合もある

例外:

UnsupportedOperationException - put オペレーションがこのマップでサポートされない場合

ClassCastException - 指定されたキーまたは値のクラスが原因で、このマップにそれらを格納できない場合

NullPointerException - このマップが null キーや null 値を許可しないときに、指定されたキーまたは値が null の場合

IllegalArgumentException - 指定されたキーまたは値のあるプロパティーが原因で、このマップにそれらを格納できない場合

remove

boolean remove(Object key,
               Object value)

指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを削除します。これは次の記述と同等です。

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

ただし、アクションが原子的に実行される点が異なります。

パラメータ:

key - 指定された値が関連付けられるキー

value - 指定されたキーに関連付けられていると予想される値

戻り値:

値が削除された場合は true

例外:

UnsupportedOperationException - remove オペレーションがこのマップでサポートされない場合

ClassCastException - キーまたは値がマップに適さない型の場合 (省略可能)

NullPointerException - このマップが null キーや null 値を許可しないときに、指定されたキーまたは値が null の場合 (省略可能)

replace

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

指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを置換します。これは次の記述と同等です。

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

ただし、アクションが原子的に実行される点が異なります。

パラメータ:

key - 指定された値が関連付けられるキー

oldValue - 指定されたキーに関連付けられていると予想される値

newValue - 指定されたキーに関連付けられる値

戻り値:

値が置換された場合は true

例外:

UnsupportedOperationException - put オペレーションがこのマップでサポートされない場合

ClassCastException - 指定されたキーまたは値のクラスが原因で、このマップにそれらを格納できない場合

NullPointerException - このマップが null キーや null 値を許可しないときに、指定されたキーまたは値が null の場合

IllegalArgumentException - 指定されたキーまたは値のあるプロパティーが原因で、このマップにそれらを格納できない場合

replace

V replace(K key,
          V value)

キーが値に現在マッピングされている場合にのみ、そのキーのエントリを置換します。これは次の記述と同等です。

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

ただし、アクションが原子的に実行される点が異なります。

パラメータ:

key - 指定された値が関連付けられるキー

value - 指定されたキーに関連付けられる値

戻り値:

指定されたキーに関連付けられた以前の値。キーのマッピングがなかった場合は null。また、実装が null 値をサポートしている場合、戻り値 null は、以前にマップでキーと null が関連付けられていたことを示す場合もある

例外:

UnsupportedOperationException - put オペレーションがこのマップでサポートされない場合

ClassCastException - 指定されたキーまたは値のクラスが原因で、このマップにそれらを格納できない場合

NullPointerException - このマップが null キーや null 値を許可しないときに、指定されたキーまたは値が null の場合

IllegalArgumentException - 指定されたキーまたは値のあるプロパティーが原因で、このマップにそれらを格納できない場合