モジュール java.base

パッケージ java.util.concurrent

クラスConcurrentHashMap.KeySetView<K,V>

java.lang.Object

java.util.concurrent.ConcurrentHashMap.KeySetView<K,V>

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

Serializable, Iterable<K>, Collection<K>, Set<K>

含まれているクラス:

ConcurrentHashMap<K,V>

public static class ConcurrentHashMap.KeySetView<K,V>
extends Object
implements Set<K>, Serializable

キーのSetとしてのConcurrentHashMapのビューです。オプションで、共通の値にマップすることによって追加を有効化できます。 このクラスは直接インスタンス化できません。 keySet()、keySet(V)、newKeySet()、newKeySet(int)を参照してください。

導入されたバージョン:

1.8

関連項目:

直列化された形式

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(K e)	バッキング・マップ内のデフォルトのマップされた値(定義されている場合)にキーをマップすることにより、指定されたキーをこのセット・ビューに追加します。
boolean	addAll(Collection<? extends K> c)	指定されたコレクションのすべての要素をこのセットに追加します。各要素に対してadd(K)を呼び出した場合と同様です。
void	clear()	このビューのバッキング・マップからすべてのマッピングを削除することにより、このビューからすべての要素を削除します。
boolean	contains(Object o)	指定された要素がコレクションに含まれている場合にtrueを返します。
boolean	containsAll(Collection<?> c)	指定されたコレクションのすべての要素がこのコレクション内にある場合はtrueを返します。
boolean	equals(Object o)	このオブジェクトとほかのオブジェクトが等しいかどうかを示します。
void	forEach(Consumer<? super K> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。
ConcurrentHashMap<K,V>	getMap()	このビューのバッキング・マップを返します。
V	getMappedValue()	追加に対するデフォルトのマップされた値を返します。追加がサポートされていない場合はnullを返します。
int	hashCode()	オブジェクトのハッシュ・コード値を返します。
boolean	isEmpty()	このコレクションに要素がない場合にtrueを返します。
Iterator<K>	iterator()	コレクションの要素のイテレータを返します。
boolean	remove(Object o)	バッキング・マップからキー(およびそれに対応する値)を削除することで、このマップ・ビューからキーを削除します。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
int	size()	このコレクション中の要素の数を返します。
Spliterator<K>	spliterator()	このセット内の要素に対するSpliteratorを作成します。
Object[]	toArray()	このコレクションの要素がすべて格納されている配列を返します。
<T> T[]	toArray(T[] a)	このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。
String	toString()	このコレクションの文字列表現を返します。

インタフェース java.util.Collectionから継承されたメソッド

parallelStream, removeIf, stream

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

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

インタフェース java.util.Setから継承されたメソッド

clear, containsAll, isEmpty, of, of, of, of, of, of, of, of, of, of, of, of, removeAll, retainAll, size, toArray, toArray

メソッドの詳細

getMappedValue

public V getMappedValue()

追加に対するデフォルトのマップされた値を返します。追加がサポートされていない場合はnullを返します。

戻り値:

追加に対するデフォルトのマップされた値。サポートされていない場合はnull

contains

public boolean contains(Object o)

指定された要素がコレクションに含まれている場合にtrueを返します。 より正式には、trueは、このコレクションに少なくとも1つの要素e(Objects.equals(o, e)など)が含まれている場合にのみ返されます。

定義:

contains、インタフェース: Collection<K>

定義:

contains、インタフェース: Set<K>

パラメータ:

o - このコレクション内にあるかどうかが判定される要素

戻り値:

指定された要素がこのコレクション内にある場合はtrue

例外:

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

remove

public boolean remove(Object o)

バッキング・マップからキー(およびそれに対応する値)を削除することで、このマップ・ビューからキーを削除します。 そのキーがマップにない場合は、何も行いません。

定義:

remove、インタフェース: Collection<K>

定義:

remove、インタフェース: Set<K>

パラメータ:

o - バッキング・マップから削除されるキー

戻り値:

指定された要素がバッキング・マップに含まれていた場合はtrue

例外:

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

iterator

public Iterator<K> iterator()

コレクションの要素のイテレータを返します。

返されるイテレータは弱一貫性を保持します。

定義:

iterator、インタフェース: Collection<K>

定義:

iterator、インタフェース: Iterable<K>

定義:

iterator、インタフェース: Set<K>

戻り値:

バッキング・マップのキーに対するイテレータ

add

public boolean add(K e)

バッキング・マップ内のデフォルトのマップされた値(定義されている場合)にキーをマップすることにより、指定されたキーをこのセット・ビューに追加します。

定義:

add、インタフェース: Collection<K>

定義:

add、インタフェース: Set<K>

パラメータ:

e - 追加されるキー

戻り値:

呼出しの結果としてこのセットが変更された場合はtrue

例外:

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

UnsupportedOperationException - 追加に対するデフォルトのマップされた値が指定されていなかった場合

addAll

public boolean addAll(Collection<? extends K> c)

指定されたコレクションのすべての要素をこのセットに追加します。各要素に対してadd(K)を呼び出した場合と同様です。

定義:

addAll、インタフェース: Collection<K>

定義:

addAll、インタフェース: Set<K>

パラメータ:

c - このセットに挿入される要素

戻り値:

呼出しの結果としてこのセットが変更された場合はtrue

例外:

NullPointerException - コレクションまたはそのいずれかの要素がnullである場合

UnsupportedOperationException - 追加に対するデフォルトのマップされた値が指定されていなかった場合

関連項目:

Set.add(Object)

hashCode

public int hashCode()

次のクラスからコピーされた説明: Object

オブジェクトのハッシュ・コード値を返します。 このメソッドは、HashMapによって提供されるハッシュ・テーブルなどの、ハッシュ・テーブルの利点のためにサポートされています。

hashCodeの一般的な規則は次のとおりです。

• Javaアプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対するequalsの比較で使用される情報が変更されていなければ、hashCodeメソッドは常に同じ整数を返す必要があります。 ただし、この整数は同じアプリケーションの実行ごとに同じである必要はありません。
• equals(Object)メソッドに従って2つのオブジェクトが等しい場合は、2つの各オブジェクトに対するhashCodeメソッドの呼出しによって同じ整数の結果が生成される必要があります。
• Object.equals(java.lang.Object)メソッドに従って2つのオブジェクトが等しくない場合は、2つの各オブジェクトに対するhashCodeメソッドの呼出しによって異なる整数の結果が生成される必要はありません。 ただし、プログラマは、等しくないオブジェクトに対して異なる整数の結果を生成すると、ハッシュ・テーブルのパフォーマンスが向上する可能性があることに注意するようにしてください。

クラスObjectによって定義されたhashCodeメソッドは、可能なかぎり、異なるオブジェクトに対して異なる整数を返します。 (hashCodeは、ある時点におけるオブジェクト・メモリー・アドレスの関数として実装されても実装されなくてもよい。)

定義:

hashCode、インタフェース: Collection<K>

定義:

hashCode、インタフェース: Set<K>

オーバーライド:

hashCode、クラス: Object

戻り値:

このオブジェクトのハッシュ・コード値

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object o)

次のクラスからコピーされた説明: Object

このオブジェクトとほかのオブジェクトが等しいかどうかを示します。

equalsメソッドは、null以外のオブジェクト参照での同値関係を実装します。

• 反射性(reflexive): null以外の参照値xについて、x.equals(x)はtrueを返します。
• 対称性(symmetric): null以外の参照値xおよびyについて、y.equals(x)がtrueを返す場合に限り、x.equals(y)はtrueを返します。
• 推移性(transitive): null以外の参照値x、y、およびzについて、x.equals(y)がtrueを返し、y.equals(z)がtrueを返す場合、x.equals(z)はtrueを返します。
• 一貫性(consistent): null以外の参照値xおよびyについて、x.equals(y)の複数の呼出しは、このオブジェクトに対するequalsによる比較で使われた情報が変更されていなければ、一貫してtrueを返すか、一貫してfalseを返します。
• null以外の参照値xについて、x.equals(null)はfalseを返します。

Objectクラスのequalsメソッドは、もっとも比較しやすいオブジェクトの同値関係を実装します。つまり、null以外の参照値xとyについて、このメソッドはxとyが同じオブジェクトを参照する(x == yがtrue)場合にだけtrueを返します。

通常、このメソッドをオーバーライドする場合は、hashCodeメソッドを常にオーバーライドして、「等価なオブジェクトは等価なハッシュ・コードを保持する必要がある」というhashCodeメソッドの汎用規約に従う必要があることに留意してください。

定義:

equals、インタフェース: Collection<K>

定義:

equals、インタフェース: Set<K>

オーバーライド:

equals、クラス: Object

パラメータ:

o - 比較対象の参照オブジェクト。

戻り値:

このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse。

関連項目:

Object.hashCode()、HashMap

spliterator

public Spliterator<K> spliterator()

インタフェースからコピーされた説明: Set

このセット内の要素に対するSpliteratorを作成します。

SpliteratorはSpliterator.DISTINCTを報告します。 実装は、追加の特性値の報告をドキュメント化する必要があります。

定義:

spliterator、インタフェース: Collection<K>

定義:

spliterator、インタフェース: Iterable<K>

定義:

spliterator、インタフェース: Set<K>

戻り値:

このセット内の要素に対するSpliterator

forEach

public void forEach(Consumer<? super K> action)

インタフェースからコピーされた説明: Iterable

Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。

オーバーライドするクラスが並行変更ポリシーを指定していない限り、アクションが要素の基本ソースを変更する副作用を実行する場合、このメソッドの動作は指定されていません。

定義:

forEach、インタフェース: Iterable<K>

パラメータ:

action - 各要素に対して実行されるアクション

getMap

public ConcurrentHashMap<K,V> getMap()

このビューのバッキング・マップを返します。

戻り値:

このビューのバッキング・マップ

clear

public final void clear()

このビューのバッキング・マップからすべてのマッピングを削除することにより、このビューからすべての要素を削除します。

定義:

インタフェースCollection<K>内のclear

size

public final int size()

次のインタフェースからコピーされた説明: Collection

このコレクション中の要素の数を返します。 このコレクションにInteger.MAX_VALUEより多くの要素がある場合は、Integer.MAX_VALUEを返します。

定義:

インタフェースCollection<K>内のsize

戻り値:

このコレクションの要素数

isEmpty

public final boolean isEmpty()

次のインタフェースからコピーされた説明: Collection

このコレクションに要素がない場合にtrueを返します。

定義:

インタフェースCollection<K>内のisEmpty

戻り値:

このコレクションに要素が含まれていない場合はtrue

toArray

public final Object[] toArray()

次のインタフェースからコピーされた説明: Collection

このコレクションの要素がすべて格納されている配列を返します。 イテレータによって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。

返される配列への参照をコレクションが維持しないという点で、この配列は安全です。 つまり、このメソッドは、コレクションが配列に連動している場合でも新しい配列を割り当てます。 このため、呼出し側は、返された配列を自由に変更できます。

このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。

定義:

インタフェースCollection<K>内のtoArray

戻り値:

コレクションのすべての要素が格納されている配列

toArray

public final <T> T[] toArray(T[] a)

次のインタフェースからコピーされた説明: Collection

このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。 コレクションが指定された配列に収まる場合は、その中に返されます。 そうでない場合は、指定された配列の実行時の型とコレクションのサイズを持つ新しい配列が割り当てられます。

このコレクションが指定された配列に収まり、その配列にさらに余裕がある場合(つまり、配列がこのコレクションより多くの要素を持つ場合)、その配列内でコレクションの終端よりあとの要素はnullに設定されます。 このコレクションにnull要素がないことを呼出し側が知っている場合にだけ、この特性を利用してコレクションの長さを判断できます。

イテレータによって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。

Collection.toArray()メソッドと同じように、このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。 さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割当ての手間を抑えるために使用できます。

xが、文字列だけからなるコレクションであることがわかっていると仮定します。 次のコードを使うと、新しく割り当てられたStringの配列内にコレクションをダンプできます。

     String[] y = x.toArray(new String[0]);

toArray(new Object[0])は、機能の点でtoArray()と同一です。

定義:

インタフェースCollection<K>内のtoArray

型パラメータ:

T - コレクションを含む配列の実行時の型

パラメータ:

a - 配列が十分な大きさを持つ場合は、このコレクションの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。

戻り値:

コレクションのすべての要素が格納されている配列

toString

public final String toString()

このコレクションの文字列表現を返します。 文字列表現は、コレクションの要素の文字列表現をそのイテレータが返した順に角括弧("[]")で囲んだもので構成されます。 隣接する要素は、文字", " (カンマと空白文字)によって区切られます。 要素は、String.valueOf(Object)により文字列に変換されます。

オーバーライド:

toString、クラス: Object

戻り値:

このコレクションの文字列表現

containsAll

public final boolean containsAll(Collection<?> c)

次のインタフェースからコピーされた説明: Collection

指定されたコレクションのすべての要素がこのコレクション内にある場合はtrueを返します。

定義:

インタフェースCollection<K>内のcontainsAll

パラメータ:

c - このコレクションにあるかどうかを調べるコレクション

戻り値:

指定されたコレクションのすべての要素がこのコレクション内にある場合はtrue

関連項目:

Collection.contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

次のインタフェースからコピーされた説明: Collection

指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。 この呼出しの結果、このコレクションには指定されたコレクションと共通の要素はなくなります。

定義:

インタフェースCollection<K>内のremoveAll

パラメータ:

c - このコレクションから削除される要素を含むコレクション

戻り値:

呼出しの結果としてこのコレクションが変更された場合はtrue

関連項目:

Collection.remove(Object), Collection.contains(Object)

retainAll

public final boolean retainAll(Collection<?> c)

次のインタフェースからコピーされた説明: Collection

このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。 つまり、指定されたコレクションに格納されていないすべての要素をこのコレクションから削除します。

定義:

インタフェースCollection<K>内のretainAll

パラメータ:

c - このコレクションで保持される要素を含むコレクション

戻り値:

呼出しの結果としてこのコレクションが変更された場合はtrue

関連項目:

Collection.remove(Object), Collection.contains(Object)