クラスAbstractMap<K,V>
- 型パラメータ:
K
- このマップで保持されるキーの型V
- マップされる値の型
- すべての実装されたインタフェース:
Map<K,
V>
- 直系の既知のサブクラス:
ConcurrentHashMap
,ConcurrentSkipListMap
,EnumMap
,HashMap
,IdentityHashMap
,TreeMap
,WeakHashMap
Map
インタフェースのスケルトン実装を提供します。
変更不可能なマップを実装するには、プログラマは、このクラスを拡張して、マップのマッピングのセット・ビューを返すentrySet
メソッドの実装を提供するだけで済みます。 通常、返されるセットは、AbstractSet
上で実装されます。 このセットは、add
またはremove
メソッドをサポートしていない必要があり、そのイテレータはremove
メソッドをサポートしていない必要があります。
変更可能なマップを実装するには、プログラマはさらにこのクラスのput
メソッド(それ以外の場合はUnsupportedOperationException
をスロー)をオーバーライドする必要があります。また、entrySet().iterator()
から戻されるイテレータは、remove
メソッドも実装する必要があります。
プログラマは、通常、Map
インタフェース仕様の推奨事項に従って、void (引数なし)およびmapコンストラクタを指定する必要があります。
実装の詳細については、このクラスの抽象メソッド以外の各メソッドのドキュメントを参照してください。 より効率的な実装ができるマップの場合は、これらのメソッドをオーバーライドしてもかまいません。
このクラスは、Java Collections Frameworkのメンバーです。
- 導入されたバージョン:
- 1.2
- 関連項目:
-
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static class
キーと値を保持するエントリ。static class
キーと値を保守する変更不可のエントリ。 -
コンストラクタのサマリー
コンストラクタ -
メソッドのサマリー
修飾子と型メソッド説明void
clear()
マップからマッピングをすべて削除します(オプションの操作)。protected Object
clone()
このAbstractMap
インスタンスのシャロー・コピーを返します: キーと値自体はクローンされません。boolean
containsKey
(Object key) 指定されたキーのマッピングがこのマップに含まれている場合にtrue
を返します。boolean
containsValue
(Object value) このマップが1つまたは複数のキーと指定された値をマッピングしている場合にtrue
を返します。boolean
指定されたオブジェクトがこのマップと等しいかどうかを比較します。指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合はnull
を返します。int
hashCode()
マップのハッシュ・コード値を返します。boolean
isEmpty()
このマップがキーと値のマッピングを保持しない場合にtrue
を返します。keySet()
このマップに含まれるキーのSet
ビューを返します。指定された値と指定されたキーをこのマップで関連付けます(オプションの操作)。void
指定されたマップのすべてのマッピングをこのマップにコピーします(オプションの操作)。このマップからキーのマッピング(ある場合)を削除します(オプションの操作)。int
size()
このマップ内のキー値マッピングの数を返します。toString()
このマップの文字列表現を返します。values()
このマップに含まれる値のCollection
ビューを返します。インタフェースjava.util.Mapで宣言されたメソッド
compute, computeIfAbsent, computeIfPresent, entrySet, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
コンストラクタの詳細
-
AbstractMap
protected AbstractMap()唯一のコンストラクタです。 (サブクラスのコンストラクタによる呼出し用で、通常は暗黙的に呼び出されます。)
-
-
メソッドの詳細
-
size
-
isEmpty
-
containsValue
public boolean containsValue(Object value) このマップが1つまたは複数のキーと指定された値をマッピングしている場合にtrue
を返します。 より正式には、このマップに値v
へのマッピングがObjects.equals(value, v)
のように少なくとも1つ含まれている場合にのみ、true
を返します。 この操作では、Map
インタフェースのほとんどの実装で、マップ・サイズに時間線形が必要になる場合があります。- 定義:
- インタフェース
Map<K,
内のV> containsValue
- 実装要件:
- この実装では、
entrySet()
に対して、指定した値を持つエントリの検索を繰り返します。 そのようなエントリが見つかった場合は、true
が返されます。 そのようなエントリを検出せずに反復が終了すると、false
が返されます。 この実装では、マップのサイズに正比例した時間が必要なことに注意してください。 - パラメータ:
value
- このマップにあるかどうかが判定される値- 戻り値:
- このマップが1つまたは複数のキーを指定された値にマッピングしている場合は
true
- 例外:
ClassCastException
- 値がマップに適さない型の場合(オプション)NullPointerException
- 指定された値がnullであり、このマップがnull値を許可しない場合(オプション)
-
containsKey
public boolean containsKey(Object key) 指定されたキーのマッピングがこのマップに含まれている場合にtrue
を返します。 より正式には、このマップにObjects.equals(key, k)
などのキーk
のマッピングが含まれている場合のみ、true
を返します。 (このようなマッピングは1つのみ存在できます。)- 定義:
- インタフェース
Map<K,
内のV> containsKey
- 実装要件:
- この実装は、指定されたキーを持つエントリの検索を
entrySet()
に対して繰り返します。 そのようなエントリが見つかった場合は、true
が返されます。 そのようなエントリを検出せずに反復が終了すると、false
が返されます。 この実装では、マップのサイズに正比例した時間が必要なことに注意してください。多くの実装は、このメソッドをオーバーライドします。 - パラメータ:
key
- このマップ内にあるかどうかが判定されるキー- 戻り値:
- 指定されたキーのマッピングがこのマップに含まれている場合は
true
- 例外:
ClassCastException
- このキーがこのマップに適さない型の場合(オプション)NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合(オプション)
-
get
指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合はnull
を返します。より正式には、このマップにキー
k
から値v
へのマッピング(Objects.equals(key, k)
など)が含まれる場合、このメソッドはv
を返します。それ以外の場合はnull
を返します。 (このようなマッピングは1つのみ存在できます。)このマップがnull値を許可する場合、戻り値の
null
は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーをnull
にマップすることもあります。containsKey
操作を使うと、これら2つのケースを見分けることができます。- 定義:
- インタフェース
Map<K,
内のV> get
- 実装要件:
- この実装は、指定されたキーを持つエントリの検索を
entrySet()
に対して繰り返します。 そのようなエントリが見つかった場合は、エントリの値を返します。 そのようなエントリを検出せずに反復が終了すると、null
が返されます。 この実装では、マップのサイズに正比例した時間が必要なことに注意してください。多くの実装は、このメソッドをオーバーライドします。 - パラメータ:
key
- 関連付けられた値が返されるキー- 戻り値:
- 指定されたキーがマップされている値。そのキーのマッピングがこのマップに含まれていない場合は
null
- 例外:
ClassCastException
- このキーがこのマップに適さない型の場合(オプション)NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合(オプション)
-
put
指定された値と指定されたキーをこのマップで関連付けます(オプションの操作)。 マップにすでにこのキーに対するマッピングがある場合、古い値は指定された値に置き換えられます。 (マップm
には、m.containsKey(k)
がtrue
を返す場合にのみ、キーk
のマッピングが含まれていると記述されます。)- 定義:
- インタフェース
Map<K,
内のV> put
- 実装要件:
- この実装は、常に
UnsupportedOperationException
をスローします。 - パラメータ:
key
- 指定された値が関連付けられるキーvalue
- 指定されたキーに関連付けられる値- 戻り値:
key
に以前に関連付けられていた値。key
のマッピングが存在しなかった場合はnull
。 (null
の戻り値は、実装でnull
値がサポートされている場合、マップが以前にnull
をkey
に関連付けたことも示すことができます。)- 例外:
UnsupportedOperationException
-put
オペレーションがこのマップでサポートされない場合ClassCastException
- 指定されたキーまたは値のクラスが原因で、このマップにそれらを格納できない場合NullPointerException
- 指定されたキーまたは値がnullであり、このマップがnullのキーまたは値を許可しない場合IllegalArgumentException
- 指定されたキーまたは値のあるプロパティが原因で、このマップにそれらを格納できない場合
-
remove
このマップからキーのマッピング(ある場合)を削除します(オプションの操作)。 より正式には、このマップにキーk
から値v
へのマッピングが含まれている場合(Objects.equals(key, k)
など)、そのマッピングは削除されます。 マップはこのようなマッピングを1つだけ含めることができます。このマップが以前にキーを関連付けた値を返します。マップにキーのマッピングが含まれていない場合は
null
を返します。このマップでNULL値が許可されている場合、
null
の戻り値は「必ずしも」マップにキーのマッピングが含まれていないことを示しません。マップによってキーがnull
に明示的にマップされている可能性もあります。呼出しが戻ると、マップは指定されたキーのマッピングを含まなくなります。
- 定義:
- インタフェース
Map<K,
内のV> remove
- 実装要件:
- この実装は、指定されたキーを持つエントリの検索を
entrySet()
に対して繰り返します。 そのようなエントリが見つかった場合、その値はgetValue
操作で取得され、そのエントリはイテレータのremove
操作でコレクション(およびバッキング・マップ)から削除され、保存された値が返されます。 そのようなエントリを検出せずに反復が終了すると、null
が返されます。 この実装では、マップのサイズに正比例した時間が必要なことに注意してください。多くの実装は、このメソッドをオーバーライドします。entrySet
イテレータがremove
メソッドをサポートしておらず、このマップに指定したキーのマッピングが含まれている場合、この実装はUnsupportedOperationException
をスローすることに注意してください。 - パラメータ:
key
- マッピングがマップから削除されるキー- 戻り値:
key
に以前に関連付けられていた値。key
のマッピングが存在しなかった場合はnull
。- 例外:
UnsupportedOperationException
-remove
オペレーションがこのマップでサポートされない場合ClassCastException
- このキーがこのマップに適さない型の場合(オプション)NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合(オプション)
-
putAll
指定されたマップのすべてのマッピングをこのマップにコピーします(オプションの操作)。 このコールの効果は、指定されたマップ内のキーk
から値v
へのマッピングごとに、このマップでput(k, v)
を1回コールすることと同等です。 オペレーションの進行中に、指定されたマップが変更された場合の、このオペレーションの動作は定義されていません。 指定したマップに「見つける」が定義されている場合、そのマッピングの処理は通常、その順序で実行されます。- 定義:
- インタフェース
Map<K,
内のV> putAll
- 実装要件:
- この実装は、指定されたマップの
entrySet()
コレクションに対して反復処理を行い、このマップのput
操作を、反復によって返されるエントリごとに1回コールします。このマップが
put
操作をサポートせず、指定されたマップが空でない場合、この実装はUnsupportedOperationException
をスローすることに注意してください。 - パラメータ:
m
- このマップに格納されるマッピング- 例外:
UnsupportedOperationException
-putAll
操作がこのマップでサポートされていない場合ClassCastException
- 指定されたマップ内のキーまたは値のクラスが原因で、このマップにそれらを格納できない場合NullPointerException
- 指定されたマップがnullである場合、またはこのマップがnullのキーまたは値を許可せず、指定されたマップにnullのキーまたは値が含まれている場合IllegalArgumentException
- 指定されたマップ内のキーまたは値のあるプロパティが原因で、このマップにそれらを格納できない場合
-
clear
public void clear()マップからマッピングをすべて削除します(オプションの操作)。 この呼出しが戻ると、マップは空になります。- 定義:
- インタフェース
Map<K,
内のV> clear
- 実装要件:
- この実装は
entrySet().clear()
を呼び出します。entrySet
がclear
操作をサポートしていない場合、この実装はUnsupportedOperationException
をスローすることに注意してください。 - 例外:
UnsupportedOperationException
-clear
操作がこのマップでサポートされていない場合
-
keySet
このマップに含まれるキーのSet
ビューを返します。 セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremove
オペレーションを除く)。 セットは要素の削除をサポートします。Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションで対応するマッピングをマップから削除します。add
またはaddAll
操作はサポートされていません。- 定義:
- インタフェース
Map<K,
内のV> keySet
- 実装要件:
- この実装は、
AbstractSet
をサブクラス化するセットを返します。 サブクラスのイテレータ・メソッドは、このマップのentrySet()
イテレータに"ラッパー・オブジェクト"を返します。size
メソッドは、このマップのsize
メソッドに委任され、contains
メソッドは、このマップのcontainsKey
メソッドに委任されます。Setは、このメソッドが最初に呼び出されたときに作成され、それに続くすべての呼出しに応じて返されます。 同期は一切行われません。このため、わずかながら、このメソッドへの複数の呼出しに対して、同じSetが返されない可能性があります。
- 戻り値:
- マップに含まれているキーのセット・ビュー
-
values
public Collection<V> values()このマップに含まれる値のCollection
ビューを返します。 コレクションはマップと連動しているので、マップに対する変更はコレクションに反映され、またコレクションに対する変更はマップに反映されます。 コレクションの反復処理中にマップが変更された場合、反復処理の結果は定義されません(イテレータ自身のremove
オペレーションを除く)。 コレクションは要素の削除をサポートしており、対応するマッピングをマップから削除できます。削除は、Iterator.remove
、Collection.remove
、removeAll
、retainAll
、およびclear
オペレーションを通して行います。add
またはaddAll
操作はサポートされていません。- 定義:
- インタフェース
Map<K,
内のV> values
- 実装要件:
- この実装は、
AbstractCollection
をサブクラス化するコレクションを返します。 サブクラスのイテレータ・メソッドは、このマップのentrySet()
イテレータに"ラッパー・オブジェクト"を返します。size
メソッドは、このマップのsize
メソッドに委任され、contains
メソッドは、このマップのcontainsValue
メソッドに委任されます。コレクションは、このメソッドが最初に呼び出されたときに作成され、それに続くすべての呼出しに応じて返されます。 同期は一切行われません。このため、わずかながら、このメソッドへの複数の呼出しに対して、同じコレクションが返されない可能性があります。
- 戻り値:
- マップ内に含まれている値のコレクション・ビュー
-
equals
public boolean equals(Object o) 指定されたオブジェクトがこのマップと等しいかどうかを比較します。 指定されたオブジェクトもマップであり、2つのマップが同じマッピングを表す場合にtrue
を返します。 つまり、m1.entrySet().equals(m2.entrySet())
である場合、2つのマップm1
とm2
は同じマッピングを表します。 これにより、equals
メソッドがMap
インタフェースのさまざまな実装間で正しく動作することが保証されます。- 定義:
- インタフェース
Map<K,
内のV> equals
- オーバーライド:
equals
、クラスObject
- 実装要件:
- この実装では、最初に指定されたオブジェクトがこのマップであるかどうかをチェックし、その場合は
true
を返します。 次に、指定したオブジェクトが、このマップのサイズと同一のマップであるかどうかをチェックします。マップされていない場合は、false
を返します。 その場合、このマップのentrySet
コレクションに対して反復処理が行われ、指定したマップにこのマップに含まれる各マッピングが含まれていることを確認します。 指定したマップにこのようなマッピングが含まれていない場合、false
が返されます。 反復が完了すると、true
が返されます。 - パラメータ:
o
- このマップと等しいかどうかが比較されるオブジェクト- 戻り値:
- 指定されたオブジェクトがこのマップと等しい場合は
true
- 関連項目:
-
hashCode
public int hashCode()マップのハッシュ・コード値を返します。 マップのハッシュ・コードは、マップのentrySet()
ビューの各エントリのハッシュ・コードの合計として定義されます。 これにより、Object.hashCode()
の一般的な契約で必要となる、m1
およびm2
の2つのマップに対してm1.equals(m2)
がm1.hashCode()==m2.hashCode()
であることを意味します。 -
toString
public String toString()このマップの文字列表現を返します。 文字列表現は、マップのentrySet
ビューのイテレータによって返される順序で、中カッコ("{}"
)で囲まれたキーと値のマッピングのリストで構成されます。 隣接するマッピングは、文字", "
(カンマと空白文字)によって区切られます。 各キーと値のマッピングは、キーとしてレンダリングされ、その後に等号("="
)が続き、関連付けられた値が続きます。 キーと値は、String.valueOf(Object)
により文字列に変換されます。 -
clone
protected Object clone() throws CloneNotSupportedExceptionこのAbstractMap
インスタンスのシャロー・コピーを返します: キーと値自体はクローンされません。- オーバーライド:
clone
、クラスObject
- 戻り値:
- このマップのシャロー・コピー
- 例外:
CloneNotSupportedException
- オブジェクトのクラスがCloneable
インタフェースをサポートしていない場合。clone
メソッドをオーバーライドしたサブクラスも、インスタンスを複製できないことを示すためにこの例外をスローすることがある。- 関連項目:
-