JavaTM 2 Platform
Std. Ed. v1.3

java.util
クラス HashMap

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
すべての実装インタフェース:
Cloneable, Map, Serializable

public class HashMap
extends AbstractMap
implements Map, Cloneable, Serializable

Map インタフェースのハッシュテーブルに基づく実装です。この実装は、マップに関連するオプションのオペレーションをすべてサポートし、null 値および null キーを使用できます。HashMap クラスは Hashtable と同じと見なしてもかまいませんが、HashMap の方は同期がとられず、null の場合もあります。このクラスは、マップの順序については保証しません。特に、ある期間に渡って一定の順序を保つことを保証しません。

この実装は、ハッシュ関数が複数のバケットで要素を適切に分散させることを想定し、基本オペレーション (get および put) で一定時間の性能を提供します。コレクションビューの繰り返し処理では、HashMap のインスタンスの「容量」(バケット数) とそのサイズ (キーと値のマッピングの数) の合計に比例した時間が必要です。したがって、繰り返し処理の性能が重要な場合は、初期容量をあまり高く (または負荷係数をあまり低く) 設定しないことが重要です。

HashMap のインスタンスには、その性能に影響を与える 2 つのパラメータ「初期容量」および「負荷係数」があります。「容量」はハッシュテーブルのバケット数であり、初期容量は単純にハッシュテーブルが作成された時点での容量です。「負荷係数」は、ハッシュテーブルがどの程度いっぱいになると、ハッシュテーブルの容量が自動的に増加されるかの基準です。ハッシュテーブルエントリ数が負荷係数と現在の容量の積を超えると、容量は rehash メソッドを呼び出すことで約 2 倍になります。

ほとんどの場合、デフォルトの負荷係数 (.75) では、時間コストとスペースコストの釣り合いを取ります。この値を大きくすると、スペースのオーバーヘッドが減少しますが、参照コストが増加し、get および put を含む HashMap クラスのほとんどのオペレーションが影響を受けます。初期容量を設定するときは、rehash オペレーションの回数を最小限に抑えるために、マップのエントリ予定数および負荷係数を考慮する必要があります。初期容量が、エントリの最大数を負荷係数で割った値より大きい場合、rehash オペレーションは起こりません。

HashMap のインスタンスに多くのマッピングが格納される場合は、このテーブルの作成時に十分な大きさの容量を設定すると、必要に応じてハッシュを自動的にやり直してテーブルを大きくするよりも、マッピングをより効率的に格納できます。

この実装は同期化されません。複数のスレッドが同時にこのマップにアクセスし、それらのスレッドの少なくとも 1 つが構造的にマップを変更する場合には、外部で同期をとる必要があります。構造的な変更とは、1 つ以上のマッピングを追加または削除するオペレーションのことです。すでにインスタンスに格納されているキーに関連付けられた値を変更することは構造的な変更ではありません。通常、マップの同期をとるには、マップを自然にカプセル化するオブジェクトで同期をとります。そのようなオブジェクトがない場合には、Collections.synchronizedMap メソッドを使ってマップを「ラップ」します。これは、マップへの偶発的な非同期アクセスを防ぐために、作成時に行うのが最適です。

 Map m = Collections.synchronizedMap(new HashMap(...));
 

このクラスのすべての「コレクションビューメソッド」によって返される反復子は、「フェイルファスト」です。反復子の作成後に、反復子自体の remove メソッドまたは add メソッド以外の方法でマップを構造的に変更すると、反復子は ConcurrentModificationException をスローします。したがって、同時変更が行われると、反復子は、将来の予測できない時点において予測できない動作が発生する危険を回避するために、直ちにかつ手際よく例外をスローします。

導入されたバージョン:
1.2
関連項目:
Object.hashCode(), Collection, Map, TreeMap, Hashtable, 直列化された形式

クラス java.util.Map から継承した内部クラス
Map.Entry
 
コンストラクタの概要
HashMap()
          デフォルトの容量と負荷係数 (0.75) で新しい空のマップを作成します。
HashMap(int initialCapacity)
          指定された初期容量およびデフォルトの負荷係数 (0.75) で新しい空のマップを作成します。
HashMap(int initialCapacity, float loadFactor)
          指定された初期容量および指定された負荷係数で、新しい空のマップを作成します。
HashMap(Map t)
          指定されたマップと同じマッピングで新しいマップを作成します。
 
メソッドの概要
 void clear()
          すべてのマッピングをマップから削除します。
 Object clone()
          HashMap のインスタンスのシャローコピーを返します。
 boolean containsKey(Object key)
          マップが指定のキーのマッピングを保持する場合に true を返します。
 boolean containsValue(Object value)
          マップが 1 つまたは複数のキーと指定された値をマッピングしている場合に true を返します。
 Set entrySet()
          マップに格納されているマッピングのコレクションビューを返します。
 Object get(Object key)
          マップが指定のキーをマップする値を返します。
 boolean isEmpty()
          マップがキーと値のマッピングを保持しない場合に true を返します。
 Set keySet()
          マップに格納されているキーのセットビューを返します。
 Object put(Object key, Object value)
          指定の値をマップ内の指定のキーと関連付けます。
 void putAll(Map t)
          指定したマップからこのマップにすべてのマッピングをコピーします。
 Object remove(Object key)
          キーに対するマッピングがあれば、そのキーをマップから削除します。
 int size()
          マップ内のキーと値のマッピングの数を返します。
 Collection values()
          マップに格納されている値のコレクションビューを返します。
 
クラス java.util.AbstractMap から継承したメソッド
equals, hashCode, toString
 
クラス java.lang.Object から継承したメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait
 
インタフェース java.util.Map から継承したメソッド
equals, hashCode
 

コンストラクタの詳細

HashMap

public HashMap(int initialCapacity,
               float loadFactor)
指定された初期容量および指定された負荷係数で、新しい空のマップを作成します。
パラメータ:
initialCapacity - HashMap の初期容量
loadFactor - HashMap の負荷係数
例外:
IllegalArgumentException - 初期容量が 0 より小さいか、負荷係数が正の値ではない場合

HashMap

public HashMap(int initialCapacity)
指定された初期容量およびデフォルトの負荷係数 (0.75) で新しい空のマップを作成します。
パラメータ:
initialCapacity - HashMap の初期容量
例外:
IllegalArgumentException - 初期容量が 0 より小さい場合

HashMap

public HashMap()
デフォルトの容量と負荷係数 (0.75) で新しい空のマップを作成します。

HashMap

public HashMap(Map t)
指定されたマップと同じマッピングで新しいマップを作成します。マップは、指定されたマップにあるマッピング数の 2 倍の容量または 11 (どちらか大きい方)、およびデフォルトの負荷係数 (0.75) で作成されます。
パラメータ:
t - マッピングがこのマップに配置されるマップ
メソッドの詳細

size

public int size()
マップ内のキーと値のマッピングの数を返します。
定義:
インタフェース Map 内の size
オーバーライド:
クラス AbstractMap 内の size
戻り値:
マップ内のキーと値のマッピングの数

isEmpty

public boolean isEmpty()
マップがキーと値のマッピングを保持しない場合に true を返します。
定義:
インタフェース Map 内の isEmpty
オーバーライド:
クラス AbstractMap 内の isEmpty
戻り値:
マップがキーと値のマッピングを保持しない場合は true

containsValue

public boolean containsValue(Object value)
マップが 1 つまたは複数のキーと指定された値をマッピングしている場合に true を返します。
定義:
インタフェース Map 内の containsValue
オーバーライド:
クラス AbstractMap 内の containsValue
パラメータ:
value - マップにあるかどうかを判定される値
戻り値:
マップが 1 つまたは複数のキーと指定された値をマッピングしている場合は true

containsKey

public boolean containsKey(Object key)
マップが指定のキーのマッピングを保持する場合に true を返します。
定義:
インタフェース Map 内の containsKey
オーバーライド:
クラス AbstractMap 内の containsKey
パラメータ:
key - Map にあるかどうかが判定されるキー
戻り値:
マップが指定のキーのマッピングを保持する場合は true

get

public Object get(Object key)
マップが指定のキーをマップする値を返します。マップがこのキーのマッピングを保持していない場合は null を返します。戻り値の null は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップすることもあります。containsKey オペレーションを使うと、こうした 2 つの場合を見分けることができます。
定義:
インタフェース Map 内の get
オーバーライド:
クラス AbstractMap 内の get
パラメータ:
key - 関連付けられた値が返されるキー
戻り値:
マップが指定されたキーをマップする値

put

public Object put(Object key,
                  Object value)
指定の値をマップ内の指定のキーと関連付けます。マップが以前にこのキーのマッピングを保持していた場合、古い値が置き換えられます。
定義:
インタフェース Map 内の put
オーバーライド:
クラス AbstractMap 内の put
パラメータ:
key - 指定された値が関連付けられるキー
value - 指定されたキーに関連付けられる値
戻り値:
指定されたキーに関連した値。または、キーのマッピングがなかった場合は null。戻り値 null は、HashMap が以前に null と指定されたキーを関連付けていたことを示す場合もある

remove

public Object remove(Object key)
キーに対するマッピングがあれば、そのキーをマップから削除します。
定義:
インタフェース Map 内の remove
オーバーライド:
クラス AbstractMap 内の remove
パラメータ:
key - マッピングがマップから削除されるキー
戻り値:
指定されたキーに関連した値。または、キーのマッピングがなかった場合は null。戻り値 null は、マップが以前に null と指定されたキーを関連付けていたことを示す場合もある

putAll

public void putAll(Map t)
指定したマップからこのマップにすべてのマッピングをコピーします。 これらのマッピングによって、現在指定された Map のキーに対してこのマップが持つマッピングが置換されます。
定義:
インタフェース Map 内の putAll
オーバーライド:
クラス AbstractMap 内の putAll
パラメータ:
t - マップに格納されるマッピング

clear

public void clear()
すべてのマッピングをマップから削除します。
定義:
インタフェース Map 内の clear
オーバーライド:
クラス AbstractMap 内の clear
インタフェース java.util.Map からコピーされたタグ:
例外:
UnsupportedOperationException - clear がマップによってサポートされていない場合

clone

public Object clone()
HashMap のインスタンスのシャローコピーを返します。キーと値は、それ自体は複製されません。
オーバーライド:
クラス Object 内の clone
戻り値:
このマップのシャローコピー

keySet

public Set keySet()
マップに格納されているキーのセットビューを返します。セットはマップを基にするので、マップへの変更はセットで反映され、逆にセットへの変更はマップで反映されます。セットは、Iterator.removeSet.removeremoveAllretainAll、および clear の各オペレーションより、マップから対応するマッピングを削除する要素削除処理をサポートします。add オペレーションと addAll オペレーションは、セットではサポートされません。
定義:
インタフェース Map 内の keySet
オーバーライド:
クラス AbstractMap 内の keySet
戻り値:
マップに含まれているキーのセットビュー

values

public Collection values()
マップに格納されている値のコレクションビューを返します。コレクションはマップを基にしているので、マップへの変更はコレクションで反映され、逆にコレクションでの変更はマップで反映されます。コレクションは、Iterator.removeCollection.removeremoveAllretainAll、および clear オペレーションにより、マップから対応するマッピングを削除する要素削除処理をサポートします。add オペレーションと addAll オペレーションは、コレクションではサポートされません。
定義:
インタフェース Map 内の values
オーバーライド:
クラス AbstractMap 内の values
戻り値:
マップ内に保持されている値のコレクションビュー

entrySet

public Set entrySet()
マップに格納されているマッピングのコレクションビューを返します。返されたコレクションの各要素は Map.Entry です。コレクションはマップを基にしているので、マップへの変更はコレクションで反映され、逆にコレクションへの変更はマップで反映されます。コレクションは、Iterator.removeCollection.removeremoveAllretainAll、および clear の各オペレーションにより、マップから対応するマッピングを削除する要素削除処理をサポートします。add オペレーションと addAll オペレーションは、コレクションではサポートされません。
定義:
インタフェース Map 内の entrySet
オーバーライド:
クラス AbstractMap 内の entrySet
戻り値:
マップ内に保持されているマッピングのコレクションビュー
関連項目:
Map.Entry

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.