java.util

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

型パラメータ:

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

V - マップされる値の型

既知のすべてのサブインタフェース:

Bindings, ConcurrentMap<K,V>, ConcurrentNavigableMap<K,V>, LogicalMessageContext, MessageContext, NavigableMap<K,V>, SOAPMessageContext, SortedMap<K,V>

既知のすべての実装クラス:

AbstractMap, Attributes, AuthProvider, ConcurrentHashMap, ConcurrentSkipListMap, EnumMap, HashMap, Hashtable, IdentityHashMap, LinkedHashMap, PrinterStateReasons, Properties, Provider, RenderingHints, SimpleBindings, TabularDataSupport, TreeMap, UIDefaults, WeakHashMap

public interface Map<K,V>

キーを値にマッピングするオブジェクトです。マップには、同一のキーを複数登録できません。各キーは 1 つの値にしかマッピングできません。

このインタフェースは、インタフェースというよりむしろ完全に抽象クラスであった Dictionary クラスに代わるものです。

Mapインタフェースが提供する 3 つのコレクションビューにより、マップの内容を、キーのセット、値のコレクション、あるいはキーと値のマッピングのセットとして表示できるようになります。マップの順序は、マップのコレクションビューのイテレータが要素を返すときの順序として定義されます。TreeMap クラスなど一部のマップの実装では、順序について保証しますが、HashMap クラスなどの実装では順序は保証されません。

注:可変オブジェクトをマップキーとして使用する場合は細心の注意が必要です。オブジェクトがマップ内のキーであるときに、equals の比較に影響を与える方法でオブジェクトの値が変更された場合、マップの動作は保証されません。この禁止事項の特殊な例として、マップがそれ自身をキーとして持つことができないことが挙げられます。マップがそれ自身を値として持つことは許可されますが、その場合は細心の注意が必要です。そのようなマップでは equals メソッドおよび hashCode メソッドの動作は保証されません。

汎用マップの実装クラスはすべて、次の 2 つの標準的なコンストラクタを提供するようにしてください。空のマップを作成する void (引数なし) コンストラクタと、Map 型の引数を 1 つ持ち、その引数と同じキーと値のマッピングで新しいマップを作成するコンストラクタです。その結果、ユーザーは、後者のコンストラクタを使用して任意のマップをコピーすることにより、必要なクラスと等価なマップを作成できます。これは推奨される方法ではありませんが (インタフェースはコンストラクタを持つことができないため)、JDK での汎用マップの実装はすべてこれに従っています。

このインタフェースに含まれている「破壊的な」メソッド (処理対象のマップを変更するメソッド) は、このマップがそのオペレーションをサポートしていない場合に UnsupportedOperationException をスローするように指定されています。このとき、呼び出しがマップに影響を及ぼさない場合、これらのメソッドは UnsupportedOperationException をスローすることがありますが、必須ではありません。たとえば、マッピングを「重ね合わせる」マップが空の場合に、変更不可能なマップで putAll(Map) メソッドを呼び出すと、例外をスローすることがありますが、必須ではありません。

マップの実装には、格納できるキーと値に制限があるものもあります。たとえば、null キーと null 値を禁止する実装や、null キーの型に制限がある実装もあります。不適当なキーまたは値を挿入しようとすると、通常 NullPointerException または ClassCastException のような非チェック例外がスローされます。不適当なキーや値があるかどうかを照会しようとすると、例外がスローされる場合や、ただ false を返す場合もあります。前者の動作を実行する実装もあれば、後者の動作を実行する実装もあります。もう少し一般的に言うと、不適当なキーまたは値を処理しようとしてマップへの挿入が完了しない場合、例外がスローされるか成功するかは実装の任意です。このインタフェースの仕様では、そうした例外は「任意」と記載されています。

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

Collections Framework インタフェース内の多数のメソッドは、equals メソッドとの関連で定義されます。たとえば、containsKey(Object key) メソッドの仕様は、「このマップに (key==null ? k==null : key.equals(k)) を満たすキー k が含まれる場合にのみ、true を返す」というものです。この仕様は、「null 以外の引数 key を使用して Map.containsKey を呼び出すと、キー k で key.equals(k) が呼び出される」と理解すべきではありません。実装は、最初に 2 つのキーのハッシュコードを比較するなど、equals 呼び出しを回避するための最適化を自由に実装できます。(Object.hashCode() 仕様では、等価ではないハッシュコードを保持する 2 つのオブジェクトは等価ではないことが保証されます。)もう少し一般的に言うと、さまざまな Collections Framework インタフェースの実装で、実装者が適切と判断するなら、基本となる 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) マップが 1 つまたは複数のキーを指定された値にマッピングしている場合に true を返します。
Set<Map.Entry<K,V>>	entrySet() このマップに含まれるマッピングの Set ビューを返します。
boolean	equals(Object o) 指定されたオブジェクトがこのマップと等しいかどうかを比較します。
V	get(Object key) 指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は null を返します。
int	hashCode() マップのハッシュコード値を返します。
boolean	isEmpty() このマップがキーと値のマッピングを保持しない場合に true を返します。
Set<K>	keySet() このマップに含まれるキーの Set ビューを返します。
V	put(K key, V value) 指定された値と指定されたキーをこのマップで関連付けます (オプションの操作)。
void	putAll(Map<? extends K,? extends V> m) 指定されたマップのすべてのマッピングをこのマップにコピーします (オプションの操作)。
V	remove(Object key) このマップからキーのマッピング (ある場合) を削除します (オプションの操作)。
int	size() このマップ内のキー値マッピングの数を返します。
Collection<V>	values() このマップに含まれる値の Collection ビューを返します。

メソッドの詳細

size

int size()

このマップ内のキー値マッピングの数を返します。マップ内に Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。

戻り値:

このマップ内のキーと値のマッピングの数

isEmpty

boolean isEmpty()

このマップがキーと値のマッピングを保持しない場合に true を返します。

戻り値:

このマップがキーと値のマッピングを保持しない場合は true

containsKey

boolean containsKey(Object key)

指定のキーのマッピングがマップに含まれている場合に true を返します。つまり、このマップに、(key==null ? k==null : key.equals(k)) となるキー k が含まれている場合にのみ true を返します。(このようなマッピングは 1 つのみ存在できます。)

パラメータ:

key - このマップ内にあるかどうかが判定されるキー

戻り値:

このマップが指定されたキーのマッピングを保持する場合は true

例外:

ClassCastException - このキーがこのマップに適さない型の場合 (任意)

NullPointerException - 指定されたキーが null であり、このマップが null キーを許可しない場合 (任意)

containsValue

boolean containsValue(Object value)

マップが 1 つまたは複数のキーを指定された値にマッピングしている場合に true を返します。つまり、このマップに、(value==null ? v==null : value.equals(v)) となる値 v へのマッピングが 1 つ以上ある場合にのみ true を返します。Map インタフェースのほとんどの実装で、このオペレーションにかかる時間はマップのサイズに正比例します。

パラメータ:

value - このマップにあるかどうかが判定される値

戻り値:

このマップが 1 つまたは複数のキーを指定された値にマッピングしている場合は true

例外:

ClassCastException - 値がマップに適さない型の場合 (任意)

NullPointerException - 指定された値が null であり、このマップが null 値を許可しない場合 (任意)

get

V get(Object key)

指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は null を返します。

つまり、このメソッドは、(key==null ? k==null : key.equals(k)) となるキー k から値 v へのマッピングがこのマップに含まれている場合は v を返し、それ以外の場合は null を返します。(このようなマッピングは 1 つのみ存在できます。)

このマップが null 値を許可する場合、戻り値の null は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップすることもあります。containsKey オペレーションを使うと、これらの 2 つの場合を区別できます。

パラメータ:

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

戻り値:

指定されたキーがマップされている値。そのキーのマッピングがこのマップに含まれていない場合は null

例外:

ClassCastException - このキーがこのマップに適さない型の場合 (任意)

NullPointerException - 指定されたキーが null であり、このマップが null キーを許可しない場合 (任意)

put

V put(K key,
    V value)

指定された値と指定されたキーをこのマップで関連付けます (オプションの操作)。マップにすでにこのキーに対するマッピングがある場合、古い値は指定された値に置き換えられます。m.containsKey(k) が true を返す場合にかぎり、マップ m はキー k のマッピングを含むと言えます。

パラメータ:

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

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

戻り値:

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

例外:

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

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

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

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

remove

V remove(Object key)

このマップからキーのマッピング (ある場合) を削除します (オプションの操作)。つまり、(key==null ? k==null : key.equals(k)) となるキー k から値 v へのマッピングがこのマップに含まれる場合、このマッピングは削除されます。マップはこのようなマッピングを 1 つだけ含めることができます。

このマップが以前にこのキーを関連付けていた値を返します。キーに対するマッピングがマップになかった場合は null を返します。

このマップが null 値を許可する場合、戻り値の null は、マップがキーのマッピングを保持していなかったことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップしていた可能性もあります。

呼び出しが戻ると、マップは指定されたキーのマッピングを含まなくなります。

パラメータ:

key - マッピングがマップから削除されるキー

戻り値:

key に以前に関連付けられていた値。key のマッピングが存在しなかった場合は null。

例外:

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

ClassCastException - このキーがこのマップに適さない型の場合 (任意)

NullPointerException - 指定されたキーが null であり、このマップが null キーを許可しない場合 (任意)

putAll

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

指定されたマップのすべてのマッピングをこのマップにコピーします (オプションの操作)。この呼び出しの効果は、指定されたマップ内のキー k から値 v へのマッピングごとに、このマップに対して put(k, v) を 1 回呼び出した場合と同じです。オペレーションの進行中に、指定されたマップが変更された場合の、このオペレーションの動作は定義されていません。

パラメータ:

m - このマップに格納されるマッピング

例外:

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

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

NullPointerException - 指定されたマップが null である場合、またはこのマップが null のキーまたは値を許可せず、指定されたマップに null のキーまたは値が含まれている場合

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

clear

void clear()

マップからマッピングをすべて削除します (オプションの操作)。この呼び出しが戻ると、マップは空になります。

例外:

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

keySet

Set<K> keySet()

このマップに含まれるキーの Set ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。

戻り値:

マップに含まれているキーのセットビュー

values

Collection<V> values()

このマップに含まれる値の Collection ビューを返します。コレクションはマップと連動しているので、マップに対する変更はコレクションに反映され、またコレクションに対する変更はマップに反映されます。コレクションの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。コレクションは要素の削除をサポートします。Iterator.remove、Collection.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。

戻り値:

マップ内に含まれている値のコレクションビュー

entrySet

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

このマップに含まれるマッピングの Set ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されません (イテレータ自身の remove オペレーション、またはイテレータにより返されるマップエントリに対する setValue オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。

戻り値:

マップ内に保持されているマッピングのセットビュー

equals

boolean equals(Object o)

指定されたオブジェクトがこのマップと等しいかどうかを比較します。指定されたオブジェクトもマップであり、2 つのマップが同じマッピングを表す場合に true を返します。つまり、m1.entrySet().equals(m2.entrySet()) である場合、2 つのマップ m1 と m2 は同じマッピングを表します。これにより、Map インタフェースの実装が異なる場合でも、equals メソッドが正しく動作することが保証されます。

オーバーライド:

equals、クラス: Object

パラメータ:

o - このマップと等しいかどうかが比較されるオブジェクト

戻り値:

指定されたオブジェクトがこのマップと等しい場合は true

関連項目:

Object.hashCode(), HashMap

hashCode

int hashCode()

マップのハッシュコード値を返します。マップのハッシュコードは、そのマップの entrySet() ビュー内の各エントリのハッシュコードの合計になるように定義されます。これにより、Object.hashCode() の一般規約によって要求されるように、任意の 2 つのマップ m1 と m2 で m1.equals(m2) であれば、m1.hashCode()==m2.hashCode() となることが保証されます。

オーバーライド:

hashCode、クラス: Object

戻り値:

マップのハッシュコード値

関連項目:

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