K
- このマップで保持されるキーの型V
- マップされる値の型public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable
この実装は、ハッシュ関数が複数のバケットで要素を適切に分散させることを想定し、基本オペレーション (get および put) で一定時間の性能を提供します。コレクションビューの繰り返し処理では、HashMap のインスタンスの「容量」(バケット数) とそのサイズ (キーと値のマッピングの数) の合計に比例した時間が必要です。したがって、反復処理の性能が重要な場合は、初期容量をあまり高く (負荷係数をあまり低く) 設定しないことが非常に重要です。
HashMap のインスタンスには、その性能に影響を与える 2 つのパラメータである初期容量および負荷係数があります。容量はハッシュテーブルのバケット数であり、初期容量は単純にハッシュテーブルが作成された時点での容量です。負荷係数は、ハッシュテーブルがどの程度いっぱいになると、その容量が自動的に増加されるかの基準です。ハッシュテーブルエントリ数が負荷係数と現在の容量の積を超えると、ハッシュテーブルのハッシュがやり直され (つまり、内部データ構造が再構築され)、ハッシュテーブルのバケット数は約 2 倍になります。
ほとんどの場合、デフォルトの負荷係数 (.75) では、時間コストとスペースコストの釣り合いを取ります。この値を大きくすると、スペースのオーバーヘッドが減少しますが、参照コストが増加し、get および put を含む HashMap クラスのほとんどのオペレーションが影響を受けます。初期容量を設定するときは、rehash オペレーションの回数を最小限に抑えるために、マップのエントリ予定数および負荷係数を考慮する必要があります。初期容量が、エントリの最大数を負荷係数で割った値より大きい場合、rehash オペレーションは起こりません。
HashMap のインスタンスに多くのマッピングが格納される場合は、このテーブルの作成時に十分な大きさの容量を設定すると、必要に応じてハッシュを自動的にやり直してテーブルを大きくするよりも、マッピングをより効率的に格納できます。
この実装は同期化されません。複数のスレッドが並行してハッシュマップにアクセスし、それらのスレッドの少なくとも 1 つが構造的にマップを変更する場合には、外部で同期をとる必要があります。構造的な変更とは、1 つ以上のマッピングを追加または削除するオペレーションのことです。すでにインスタンスに格納されているキーに関連付けられた値を変更することは構造的な変更ではありません。これは通常、マップを自然にカプセル化する一部のオブジェクトで synchronized することによって達成されます。
そのようなオブジェクトが存在しない場合は、Collections.synchronizedMap
メソッドを使用してマップを「ラップ」することをお勧めします。マップが誤って synchronized なしでアクセスされるのを防ぐために、作成時に行うことをお勧めします。
Map m = Collections.synchronizedMap(new HashMap(...));
このクラスの「コレクションビューメソッド」によって返されるイテレータはフェイルファストです。イテレータの作成後に、イテレータ自体の remove メソッド以外の方法でマップが構造的に変更されると、イテレータは ConcurrentModificationException
をスローします。このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。
通常、非同期の並行変更がある場合、確かな保証を行うことは不可能なので、イテレータのフェイルファストの動作を保証することはできません。フェイルファストイテレータは最善努力原則に基づき、ConcurrentModificationException をスローします。したがって、正確を期すためにこの例外に依存するプログラムを書くことは誤りです。「イテレータのフェイルファストの動作はバグを検出するためにのみ使用すべきです」。
このクラスは、Java Collections Framework のメンバーです。
Object.hashCode()
, Collection
, Map
, TreeMap
, Hashtable
, 直列化された形式AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
コンストラクタと説明 |
---|
HashMap()
デフォルトの初期容量 (16) とデフォルトの負荷係数 (0.75) を持つ、空の HashMap を作成します。
|
HashMap(int initialCapacity)
指定された初期容量とデフォルトの負荷係数 (0.75) を持つ、空の HashMap を作成します。
|
HashMap(int initialCapacity, float loadFactor)
指定された初期容量と負荷係数を持つ、空の HashMap を作成します。
|
HashMap(Map<? extends K,? extends V> m)
指定された Map と同じマッピングで新しい HashMap を作成します。
|
修飾子と型 | メソッドと説明 |
---|---|
void |
clear()
すべてのマッピングをマップから削除します。
|
Object |
clone()
HashMap のインスタンスのシャローコピーを返します。キーと値は、それ自体は複製されません。
|
boolean |
containsKey(Object key)
指定のキーのマッピングがこのマップに含まれている場合に true を返します。
|
boolean |
containsValue(Object value)
このマップが 1 つまたは複数のキーを指定された値にマッピングしている場合に true を返します。
|
Set<Map.Entry<K,V>> |
entrySet()
このマップに含まれるマッピングの
Set ビューを返します。 |
V |
get(Object key)
指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は
null を返します。 |
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 ビューを返します。 |
equals, hashCode, toString
public HashMap(int initialCapacity, float loadFactor)
initialCapacity
- 初期容量loadFactor
- 負荷係数IllegalArgumentException
- 初期容量が負であるか、負荷係数が正でない場合public HashMap(int initialCapacity)
initialCapacity
- 初期容量。IllegalArgumentException
- 初期容量が負の場合。public HashMap()
public HashMap(Map<? extends K,? extends V> m)
m
- マッピングがこのマップに配置されるマップNullPointerException
- 指定されたマップが null の場合public int size()
public boolean isEmpty()
public V get(Object key)
null
を返します。
つまり、このメソッドは、(key==null ? k==null : key.equals(k))
となるキー k
から値 v
へのマッピングがこのマップに含まれている場合は v
を返し、それ以外の場合は null
を返します。 (このようなマッピングは 1 つのみ存在できます。)
戻り値 null
は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーを null
にマップすることもあります。containsKey
オペレーションを使うと、これらの 2 つの場合を区別できます。
get
、インタフェース: Map<K,V>
get
、クラス: AbstractMap<K,V>
key
- 関連付けられた値が返されるキーnull
put(Object, Object)
public boolean containsKey(Object key)
containsKey
、インタフェース: Map<K,V>
containsKey
、クラス: AbstractMap<K,V>
key
- このマップ内にあるかどうかが判定されるキーpublic V put(K key, V value)
public void putAll(Map<? extends K,? extends V> m)
putAll
、インタフェース: Map<K,V>
putAll
、クラス: AbstractMap<K,V>
m
- このマップに格納されるマッピングNullPointerException
- 指定されたマップが null の場合public void clear()
public boolean containsValue(Object value)
containsValue
、インタフェース: Map<K,V>
containsValue
、クラス: AbstractMap<K,V>
value
- このマップにあるかどうかが判定される値public Object clone()
clone
、クラス: AbstractMap<K,V>
Cloneable
public Set<K> keySet()
Set
ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。public Collection<V> values()
Collection
ビューを返します。コレクションはマップと連動しているので、マップに対する変更はコレクションに反映され、またコレクションに対する変更はマップに反映されます。コレクションの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。コレクションは要素の削除をサポートします。Iterator.remove、Collection.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。public Set<Map.Entry<K,V>> entrySet()
Set
ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーション、またはイテレータにより返されるマップエントリに対する setValue オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。 バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.