java.util

クラス EnumMap<K extends Enum<K>,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.EnumMap<K,V>

すべての実装されたインタフェース:

Serializable, Cloneable, Map<K,V>

public class EnumMap<K extends Enum<K>,V>
extends AbstractMap<K,V>
implements Serializable, Cloneable

列挙型のキーと一緒に使用するための特殊な Map 実装です。enum マップ内のキーはすべて、マップの作成時に、指定された単一の enum 型から明示的または暗黙的に生成される必要があります。enum マップは、内部では配列として表現されます。この表現は、非常に簡潔かつ効率的です。

enum マップは、キーの自然順序 (enum 定数の宣言される順序) で管理されます。これは、コレクションビュー (keySet()、entrySet()、および values()) により返されるイテレータに反映されます。

コレクションビューにより返されるイテレータは、弱一貫性を保持します。これらが ConcurrentModificationException をスローすることはありません。また、反復の進行中に実行されるマップへの変更の影響を表示することも、非表示にすることも可能です。

null キーは許可されません。null キーを挿入しようとすると、NullPointerException がスローされます。ただし、null キーの存在をテストしたり、削除を試みる場合は正常に機能します。null 値は指定可能です。

大半のコレクション実装と同様、EnumMap は同期されません。複数のスレッドが並行して enum マップにアクセスし、それらのスレッドの少なくとも 1 つがマップを変更する場合には、外部で同期をとる必要があります。通常、これは、enum マップを自然にカプセル化するいくつかのオブジェクトで同期をとることによって達成されます。そのようなオブジェクトが存在しない場合は、Collections.synchronizedMap(java.util.Map<K, V>) メソッドを使用してマップを「ラップ」する必要があります。これは、偶発的な非同期アクセスを防ぐために、作成時に行うのが最適です。

     Map<EnumKey, V> m
         = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...));
 

実装にあたっての注意:基本のオペレーションはすべて一定時間に実行されます。これらは通常、HashMap の対応するオペレーションよりも高速に動作します (ただし保証外)。

このクラスは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.5

関連項目:

EnumSet, 直列化された形式

ネストされたクラスのサマリー

クラス java.util.AbstractMap から継承されたネストされたクラス/インタフェース

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

インタフェース java.util.Map から継承されたネストされたクラス/インタフェース

Map.Entry<K,V>

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
EnumMap(Class<K> keyType) 指定されたキーの型を使用して空の enum マップを作成します。
EnumMap(EnumMap<K,? extends V> m) 指定された enum マップと同じキーの型を使用して、enum マップを作成します。最初は、同じマッピングを含む enum マップを作成します (同じマッピングが存在する場合)。
EnumMap(Map<K,? extends V> m) 指定されたマップから初期化された enum マップを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	clear() すべてのマッピングをマップから削除します。
EnumMap<K,V>	clone() この enum マップのシャローコピーを返します。
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() マップのハッシュコード値を返します。
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 ビューを返します。

クラス java.util.AbstractMap から継承されたメソッド

isEmpty, toString

クラス java.lang.Object から継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

EnumMap

public EnumMap(Class<K> keyType)

指定されたキーの型を使用して空の enum マップを作成します。

パラメータ:

keyType - この enum マップ用のキー型のクラスオブジェクト

例外:

NullPointerException - keyType が null である場合

EnumMap

public EnumMap(EnumMap<K,? extends V> m)

指定された enum マップと同じキーの型を使用して、enum マップを作成します。最初は、同じマッピングを含む enum マップを作成します (同じマッピングが存在する場合)。

パラメータ:

m - この enum マップの初期化元の enum マップ

例外:

NullPointerException - m が null の場合

EnumMap

public EnumMap(Map<K,? extends V> m)

指定されたマップから初期化された enum マップを作成します。指定されたマップが EnumMap インスタンスの場合、このコンストラクタは EnumMap(EnumMap) と同じ動作をします。それ以外の場合は、指定されたマップがマッピングを 1 つ以上含んでいる必要があります (新規 enum マップのキーの型を判定するため)。

パラメータ:

m - この enum マップの初期化元のマップ

例外:

IllegalArgumentException - m が EnumMap インスタンスではなく、マッピングを含まない場合

NullPointerException - m が null の場合

メソッドの詳細

size

public int size()

このマップ内のキー値マッピングの数を返します。

定義:

size、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

size、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

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

containsValue

public boolean containsValue(Object value)

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

定義:

containsValue、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

containsValue、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

戻り値:

このマップが 1 つ以上のキーをこの値にマッピングする場合は true

containsKey

public boolean containsKey(Object key)

指定のキーのマッピングがこのマップに含まれている場合に true を返します。

定義:

containsKey、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

containsKey、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

戻り値:

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

get

public V get(Object key)

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

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

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

定義:

get、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

get、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

戻り値:

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

put

public V put(K key,
    V value)

指定された値と指定されたキーをこのマップに関連付けます。マップが以前にこのキーのマッピングを保持していた場合、古い値が置き換えられます。

定義:

put、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

put、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

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

戻り値:

指定されたキーと関連付けられていた以前の値。キーのマッピングがなかった場合は null。戻り値 null は、マップが以前に null と指定されたキーを関連付けていたことを示す場合もある。

例外:

NullPointerException - 指定されたキーが null である場合

remove

public V remove(Object key)

キーに対するマッピングがあれば、そのキーをマップから削除します。

定義:

remove、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

remove、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

戻り値:

指定されたキーに関連した古い値。または、キーのエントリがなかった場合は null。戻り値 null は、マップが以前に null と指定されたキーを関連付けていたことを示す場合もある。

putAll

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

指定されたマップからすべてのマッピングをマップにコピーします。これにより、マップが指定されたマップ内に現在あるキーのすべてに対して持っていたマッピングが置き換えられます。

定義:

putAll、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

putAll、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

例外:

NullPointerException - 指定されたマップが null の場合、または指定されたマップ内の 1 つまたは複数のキーが null になる場合

clear

public void clear()

すべてのマッピングをマップから削除します。

定義:

clear、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

clear、クラス: AbstractMap<K extends Enum<K>,V>

keySet

public Set<K> keySet()

このマップに含まれるキーの Set ビューを返します。返されるセットは、Map.keySet() に概説されている汎用規約に従います。セットのイテレータは、自然順序 (enum 定数の宣言された順序) に従ってキーを返します。

定義:

keySet、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

keySet、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

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

values

public Collection<V> values()

このマップに含まれる値の Collection ビューを返します。返されるコレクションは、Map.values() に概説されている汎用規約に従います。コレクションのイテレータは、対応するキーがマップ内に表示される自然順序 (enum 定数の宣言された順序) に従って値を返します。

定義:

values、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

values、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

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

entrySet

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

このマップに含まれるマッピングの Set ビューを返します。返されるセットは、Map.keySet() に概説されている汎用規約に従います。セットのイテレータは、キーがマップ内に表示される自然順序 (enum 定数の宣言された順序) に従ってマッピングを返します。

定義:

entrySet、インタフェース: Map<K extends Enum<K>,V>

定義:

entrySet、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

enum マップに含まれるマッピングのセットビュー

equals

public boolean equals(Object o)

指定されたオブジェクトがこのマップと等しいかどうかを比較します。指定されたオブジェクトもマップであり、2 つのマップが Map.equals(Object) 規約で指定されたものと同じマッピングを表す場合、true を返します。

定義:

equals、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

equals、クラス: AbstractMap<K extends Enum<K>,V>

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode(), HashMap

hashCode

public int hashCode()

マップのハッシュコード値を返します。マップのハッシュコードは、マップの各エントリのハッシュコードの合計です。

定義:

hashCode、インタフェース: Map<K extends Enum<K>,V>

オーバーライド:

hashCode、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

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

関連項目:

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

clone

public EnumMap<K,V> clone()

この enum マップのシャローコピーを返します。値自身は複製されません。

オーバーライド:

clone、クラス: AbstractMap<K extends Enum<K>,V>

戻り値:

この enum マップのシャローコピー

関連項目:

Cloneable