java.util
クラス Hashtable

java.lang.Object
  java.util.Hashtable

public class Hashtable
extends Object

キーに対して値をマップして管理するクラスです。 キーおよび値は双方ともオブジェクトとして扱うことができるものに限って使用することができます。 このため、プリミティブ型を取り扱う場合は Integer クラスや Long クラスといったラップクラスを使用します。

キーとして指定するオブジェクトは equals メソッドと hashCode メソッドが適切に実装されていなければなりません。 ハッシュテーブルはこの２つのメソッドを使用してキーを管理します。

Java 2 Platform, Standard Edition.におけるこのクラスは負荷係数と初期容量の設定を行うことができましたが、Java 2 Platform, Micro Edition.では初期容量の設定のみが行えます。 負荷係数はデフォルトのものから変更することはできません。

あらかじめ Hashtable で取り扱う情報量が多いことがわかっている場合は初期容量を十分に大きな初期容量を指定してインスタンスを生成した方が効率的に管理を行うことができます。

例：
プリミティブ型の int に対応する値を文字列で設定する場合は、

     Hashtable hash = new Hashtable();
     hash.put(new Integer(1), " その１ ");
     hash.put(new Integer(2), " その２ ");
     hash.put(new Integer(3), " その３ ");

というように記述します。ここで設定した値を取得して表示する場合は、

     System.out.println((String) hash.get(new Integer(1)));
     System.out.println((String) hash.get(new Integer(2)));
     System.out.println((String) hash.get(new Integer(3)));

というように記述します。

このクラスはスレッドセーフに実装されています。

関連項目:

Object.equals(Object), Object.hashCode()

Hashtable

public Hashtable(int size)

指定された初期容量を持つ、空の新しいオブジェクトを構築します。

パラメータ:

size - 構築する初期容量を渡します。

Hashtable

public Hashtable()

デフォルトの容量および負荷係数を持つ、空の新しいオブジェクトを構築します。

size

public int size()

ハッシュテーブルが保持している要素数を返します。

戻り値:

保持しているのキーの数を返します。

isEmpty

public boolean isEmpty()

ハッシュテーブルに要素が存在するかどうかを返します。

戻り値:

存在しない場合は true を、存在する場合は false を返します。

keys

public Enumeration keys()

ハッシュテーブルが保持しているキーの列挙を返します。

戻り値:

キーが列挙された Enumeration インタフェースの実装オブジェクトを返します。

elements

public Enumeration elements()

ハッシュテーブルが保持している値の列挙を返します。

戻り値:

値が列挙された Enumeration インタフェースの実装オブジェクトを返します。

contains

public boolean contains(Object value)

渡されたオブジェクトがハッシュテーブルに保持している値に存在するかどうか判定し、その結果を返します。 値はハッシュ構造化されていないため、キーを対象に同様の処理を行う containsKey メソッドよりも負荷がかかります。

パラメータ:

value - 判定する対象のオブジェクトを渡します。

戻り値:

存在する場合は true を、存在しない場合は false を返します。

例外:

NullPointerException - value が null の場合に throw します。

containsKey

public boolean containsKey(Object key)

渡されたオブジェクトがハッシュテーブルに保持しているキーに存在するかどうかを判定し、その結果を返します。

パラメータ:

key - 判定する対象のオブジェクトを渡します。

戻り値:

存在する場合は true を、存在しない場合は false を返します。

例外:

NullPointerException - key が null の場合に throw します。

get

public Object get(Object key)

指定されたオブジェクトが一致するキーを持つ値を返します。

パラメータ:

key - 取り出す対象のオブジェクトを渡します。

戻り値:

キーに対応するオブジェクトがあればそのオブジェクトを、そうでなければ null を返します。

関連項目:

put(java.lang.Object, java.lang.Object)

rehash

protected void rehash()

保持しているキーと値のマップのハッシュをより大きな容量のハッシュテーブルに格納します。 ハッシュテーブルに格納されている要素数が負荷係数および現在の容量から導かれる容量を越えた場合に、自動的にこのメソッドが呼び出されます。

put

public Object put(Object key,
                  Object value)

キーとして渡されたオブジェクトと値として渡されたオブジェクトをハッシュテーブルに挿入します。 キーおよび値には null を使用することはできません。 また、オブジェクト key は適切に hashCode() メソッドを実装している必要があります。

指定したオブジェクト key と等しいとみなすことができるオブジェクトを get(Object) メソッドのパラメータで渡すことで挿入した値オブジェクトを取り出すことができます。

パラメータ:

key - ハッシュテーブル中のキーとするオブジェクトを渡します。

value - ハッシュテーブル中の値とするオブジェクトを渡します。

戻り値:

ハッシュテーブル中に渡された key に対応するキーのオブジェクトが存在した場合、その対応する値オブジェクトを返します。存在しない場合は null を返します。

例外:

NullPointerException - key あるいは value が null の場合に throw します。

関連項目:

get(java.lang.Object), Object.equals(java.lang.Object), Object.hashCode()

remove

public Object remove(Object key)

渡されたオブジェクトに対応するキーを持つキーと値をハッシュテーブルから削除します。 ハッシュテーブルにキーに対応する要素がない場合は何も行いません。

パラメータ:

key - 削除する対象のキーと一致するオブジェクトを渡します。

戻り値:

削除対象が存在した場合は削除前の値に対応するオブジェクトを返します。存在しない場合は null を返します。

clear

public void clear()

ハッシュテーブルに記録されている要素を全て削除して、空の状態にします。

toString

public String toString()

ハッシュテーブルを「比較的長い」文字列表現として返します。

オーバーライド:

クラス Object 内の toString

戻り値:

ハッシュテーブルの文字列表現を返します。