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

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

HashMap, Hashtable, Properties

public interface Map<K,V>

Map はキー K を値 V にマッピングする（関連付ける）操作を定義します。

入れ子のクラスの概要

static interface

Map.Entry<K,V> マップのエントリ（キーと値のペア）を表します。

メソッドの概要

void	clear() この Map からすべてのマッピングを除去します（オプション）。
boolean	containsKey(Object key) 指定されたキーのマッピングがこの Map に含まれているかどうかを判定します。
boolean	containsValue(Object value) 指定された値に関連付けるマッピングがこのマップに含まれているかどうかを判定します。
Set<Map.Entry<K,V>>	entrySet() この Map に含まれるマッピングの Set ビューを返します。
V	get(Object key) この Map で指定されたキーに関連付けている値を返します。
boolean	isEmpty() この Map がマッピングを保持していない場合 true、保持している場合 false を返します。
V	put(K key, V value) 指定された値を、指定されたキーの値としてこの Map で関連付けます（オプション）。
V	remove(Object key) この Map から、指定されたキーのマッピングを除去します（オプション）。
int	size() この Map が保持しているマッピングの数を返します。

メソッドの詳細

put

V put(K key,
      V value)

指定された値を、指定されたキーの値としてこの Map で関連付けます（オプション）。 この Map が指定されたキーのマッピングを保持していない場合、新たなマッピングとしてこの Map に追加されます。 この Map が指定されたキーのマッピングを保持していた場合、そのマッピングの値を指定された値で入れ替えます。 Map m がキー k のマッピングを保持している場合とは、m.containsKey(k) が true を返す場合です。

パラメータ:

key - キー

value - キーに関連づける値

戻り値:

key をキーとするマッピングが存在していた場合、関連付けられていた以前の値が返ります。 key をキーとするマッピングが存在していなかった場合、null が返ります。 null が返った場合、実装がマッピングの値として null を許容しており、null がマッピングされていた可能性もあります。

例外:

UnsupportedOperationException - このメソッドがサポートされていない場合

ClassCastException - key または value に指定されたオブジェクトをマッピングのキーまたは値としてキャストできない場合

IllegalArgumentException - key または value に指定されたオブジェクトが、その性質上マッピングのキーまたは値として使用できない場合

NullPointerException - key または value に指定されたオブジェクトが null で、この Map が null をマップのキーまたは値としてサポートしていない場合

get

V get(Object key)

この Map で指定されたキーに関連付けている値を返します。 指定されたキーのマッピングが無い場合 null を返します。 null が返った場合、指定されたキーに null が関連付けられている可能性もあります。 このケースかどうかは containsKey(java.lang.Object) メソッドで判定できます。

パラメータ:

key - キー

戻り値:

key に関連づけられている値。 key のマッピングが無い場合 null 。

例外:

ClassCastException - key に指定されたオブジェクトをマッピングのキーとしてキャストできない場合（オプション）

NullPointerException - key に指定されたオブジェクトが null で、この Map が null をマッピングのキーとしてサポートしていない場合（オプション）

remove

V remove(Object key)

この Map から、指定されたキーのマッピングを除去します（オプション）。 また、除去したマッピングの値を返します。 指定されたキーのマッピングが存在していなかった場合 null を返します。 null が返った場合、指定されたキーに null が関連付けられていた可能性もあります。

パラメータ:

key - キー

戻り値:

key に関連付けられていた値。 key のマッピングが無かった場合 null 。

例外:

ClassCastException - key に指定されたオブジェクトをマッピングのキーとしてキャストできない場合

NullPointerException - key に指定されたオブジェクトが null で、この Map が null をマッピングのキーとしてサポートしていない場合

UnsupportedOperationException - このメソッドがこの Map でサポートされていない場合

containsKey

boolean containsKey(Object key)

指定されたキーのマッピングがこの Map に含まれているかどうかを判定します。

パラメータ:

key - マッピングのキー

戻り値:

指定されたキーのマッピングがこの Map に含まれていたら true、含まれていなかったら false

例外:

ClassCastException - key に指定されたオブジェクトをマッピングのキーとしてキャストできない場合

NullPointerException - key に指定されたオブジェクトが null で、この Map が null をマッピングのキーとしてサポートしていない場合

containsValue

boolean containsValue(Object value)

指定された値に関連付けるマッピングがこのマップに含まれているかどうかを判定します。

パラメータ:

value - マッピングの値

戻り値:

指定された値に関連付けるマッピングがこのマップに含まれていたら true、含まれていなかったら false

例外:

ClassCastException - value に指定されたオブジェクトをマッピングの値としてキャストできない場合

NullPointerException - value に指定されたオブジェクトが null で、この Map が null をマッピングの値としてサポートしていない場合

size

int size()

この Map が保持しているマッピングの数を返します。 Integer.MAX_VALUE より大きい場合、Integer.MAX_VALUE を返します。

戻り値:

この Map が保持しているマッピングの数

isEmpty

boolean isEmpty()

この Map がマッピングを保持していない場合 true、保持している場合 false を返します。

戻り値:

この Map がマッピングを保持していない場合 true、保持している場合 false

clear

void clear()

この Map からすべてのマッピングを除去します（オプション）。

例外:

UnsupportedOperationException - この Map がこのメソッドをサポートしていない場合

entrySet

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

この Map に含まれるマッピングの Set ビューを返します。 Set の個々の要素は Map.Entry オブジェクトです。 Set ビューは元の Map のビューであり、一方に変更を加えると他方もそれに相当する変更がなされます。

Set では、remove メソッド、clear メソッド、および iterator.remove による要素の除去がサポートされており、要素を除去すると対応する Map でも要素が除去されます。一方、add メソッドはサポートされていません。

Set の反復子（ Iterator ）で反復処理している間に Map に変更を加える場合の振る舞いは定義されていません。ただし、Set の反復子の remove メソッドによる処理や、反復子が返したマップエントリの setValue メソッドによる変更を除きます。

戻り値:

この Map に含まれるマッピングの Set ビュー