E
- このセットで保持される要素の型public interface Set<E> extends Collection<E>
e1.equals(e2)
であるe1
とe2
の要素ペアは持たず、null要素を最大1つしか持ちません。その名前が示すように、このインタフェースは、数学で言う集合の抽象化をモデル化します。
Setインタフェースは、Collectionインタフェースから継承した規定だけでなく、すべてのコンストラクタの規約、およびadd、equals、hashCodeの各メソッドの規約に追加の規定を適用します。便宜上、ほかの継承メソッドの宣言もここに含まれます。これらの宣言に付随する仕様はSetインタフェースに合わせて調整済みですが、追加規定は含まれていません。
コンストラクタについての追加規定として、すべてのコンストラクタは、重複要素のないセットを作成しなければなりません(上記を参照)。
注: 可変オブジェクトがセット要素として使用される場合は、細心の注意が必要です。オブジェクトがセット内の要素であるときに、equalsの比較に影響を与える方法でオブジェクトの値が変更された場合、セットの動作は保証されません。この禁止事項の特例により、セットがそれ自体を要素として持つことは許可されません。
セットの実装には、格納できる要素に制限があるものもあります。たとえば、null要素を禁止する実装や、null要素の型に制限がある実装もあります。不適格な要素を追加しようとすると、通常NullPointerExceptionまたはClassCastExceptionのような非チェック例外がスローされます。不適格な要素を照会しようとすると、例外がスローされる場合や、ただfalseを返す場合もあります。前者の動作を実行する実装もあれば、後者の動作を実行する実装もあります。もう少し一般的に言うと、セットへの挿入がされない不適当な要素を処理しようとすると、例外がスローされる場合や、処理が有効になる場合があります。このインタフェースの仕様では、そうした例外は「任意」と記載されています。
このインタフェースは、Java Collections Frameworkのメンバーです。
Collection
, List
, SortedSet
, HashSet
, TreeSet
, AbstractSet
, Collections.singleton(java.lang.Object)
, Collections.EMPTY_SET
修飾子と型 | メソッドと説明 |
---|---|
boolean |
add(E e)
指定された要素がセット内になかった場合、セットに追加します(オプションの操作)。
|
boolean |
addAll(Collection<? extends E> c)
指定されたコレクションのすべての要素について、その要素がこのセット内にない場合、セットに追加します(オプションの操作)。
|
void |
clear()
セットからすべての要素を削除します(オプションの操作)。
|
boolean |
contains(Object o)
指定された要素がセットに含まれている場合にtrueを返します。
|
boolean |
containsAll(Collection<?> c)
指定されたコレクションのすべての要素がこのセットに含まれている場合にtrueを返します。
|
boolean |
equals(Object o)
指定されたオブジェクトがセットと同じかどうかを比較します。
|
int |
hashCode()
セットのハッシュ・コード値を返します。
|
boolean |
isEmpty()
このセットに要素が1つも含まれていない場合にtrueを返します。
|
Iterator<E> |
iterator()
セット内の各要素についてのイテレータを返します。
|
boolean |
remove(Object o)
指定された要素がセット内にあった場合、セットから削除します(オプションの操作)。
|
boolean |
removeAll(Collection<?> c)
このセットから、指定されたコレクションに含まれる要素をすべて削除します(オプションの操作)。
|
boolean |
retainAll(Collection<?> c)
セット内の要素のうち、指定されたコレクション内にある要素だけを保持します(オプションの操作)。
|
int |
size()
セット内の要素数(そのカーディナリティ)を返します。
|
default Spliterator<E> |
spliterator()
このセット内の要素に対する
Spliterator を作成します。 |
Object[] |
toArray()
セット内のすべての要素が格納されている配列を返します。
|
<T> T[] |
toArray(T[] a)
セット内のすべての要素を格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。
|
parallelStream, removeIf, stream
int size()
size
、インタフェース: Collection<E>
boolean isEmpty()
isEmpty
、インタフェース: Collection<E>
boolean contains(Object o)
contains
、インタフェース: Collection<E>
o
- このセット内にあるかどうかが判定される要素ClassCastException
- 指定された要素の型が、このセットと互換でない場合(オプション)NullPointerException
- 指定された要素がnullで、このセットがnull要素を許可しない場合(オプション)Iterator<E> iterator()
Object[] toArray()
返される配列への参照をセットが維持しないという点で、この配列は安全です。つまり、このメソッドは、セットが配列に連動している場合でも新しい配列を割り当てます。このため、呼出し側は、返された配列を自由に変更できます。
このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。
toArray
、インタフェース: Collection<E>
<T> T[] toArray(T[] a)
このセットが指定された配列に収まり、その配列にさらに余裕がある場合(つまり、配列がセットより多くの要素を持つ場合)、その配列内でセットの終端よりあとの要素はnullに設定されます。このセットにnull要素がないことを呼出し側が知っている場合にだけ、この特性を利用してこのセットの長さを判断できます。
イテレータによって要素が返される順序をセットが保証する場合、このメソッドは同じ順序で要素を返さなければいけません。
toArray()
メソッドと同じように、このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割当ての手間を抑えるために使用できます。
xが、文字列だけからなるセットであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられたStringの配列内にセットをダンプできます。
String[] y = x.toArray(new String[0]);toArray(new Object[0])は、機能の点でtoArray()と同一です。
toArray
、インタフェース: Collection<E>
T
- コレクションを含む配列の実行時の型a
- 配列が十分な大きさを持つ場合は、このセットの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。ArrayStoreException
- 指定された配列の実行時の型が、このセット内のすべての要素の実行時の型のスーパー・タイプでない場合NullPointerException
- 指定された配列がnullである場合boolean add(E e)
この規定は、セットがすべての要素を受け付ける必要があることを意味するわけではありません。セットは、nullを含む特定の要素の追加を拒否して例外をスローできます(Collection.add
の仕様を参照)。セットの各実装では、セットが持つことのできる要素についての制約を明記するようにしてください。
add
、インタフェース: Collection<E>
e
- このセットに追加される要素UnsupportedOperationException
- addオペレーションがこのセットでサポートされない場合ClassCastException
- 指定された要素のクラスが原因で、このセットにその要素を追加できない場合NullPointerException
- 指定された要素がnullであり、このセットがnull要素を許可しない場合IllegalArgumentException
- 指定された要素のあるプロパティが原因で、このセットにその要素を追加できない場合boolean remove(Object o)
remove
、インタフェース: Collection<E>
o
- このセットから削除されるオブジェクト(そのオブジェクトが存在する場合)ClassCastException
- 指定された要素の型が、このセットと互換でない場合(オプション)NullPointerException
- 指定された要素がnullで、このセットがnull要素を許可しない場合(オプション)UnsupportedOperationException
- removeオペレーションがこのセットでサポートされない場合boolean containsAll(Collection<?> c)
containsAll
、インタフェース: Collection<E>
c
- このセットに含まれているかどうかがチェックされるコレクションClassCastException
- 指定されたコレクションの1つ以上の要素の型が、セットと互換でない場合(オプション)NullPointerException
- 指定されたコレクションに1つ以上のnull要素が含まれており、このセットがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合contains(Object)
boolean addAll(Collection<? extends E> c)
addAll
、インタフェース: Collection<E>
c
- このセットに追加される要素を含むコレクションUnsupportedOperationException
- addAllオペレーションがこのセットでサポートされない場合ClassCastException
- 指定されたコレクションの要素のクラスが原因で、このセットにその要素を追加できない場合NullPointerException
- 指定されたコレクションに1つ以上のnull要素が含まれており、このセットがnull要素を許可しない場合、または指定されたコレクションがnullの場合IllegalArgumentException
- 指定されたコレクションの要素のあるプロパティが原因で、このセットにその要素を追加できない場合add(Object)
boolean retainAll(Collection<?> c)
retainAll
、インタフェース: Collection<E>
c
- このセットで保持される要素を含むコレクションUnsupportedOperationException
- retainAllオペレーションがこのセットでサポートされない場合ClassCastException
- このセットのある要素のクラスが、指定されたコレクションと互換でない場合(オプション)NullPointerException
- このセットにnull要素が含まれており、指定されたコレクションがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合remove(Object)
boolean removeAll(Collection<?> c)
removeAll
、インタフェース: Collection<E>
c
- このセットから削除される要素を含むコレクションUnsupportedOperationException
- removeAllオペレーションがこのセットでサポートされない場合ClassCastException
- このセットのある要素のクラスが、指定されたコレクションと互換でない場合(オプション)NullPointerException
- このセットにnull要素が含まれており、指定されたコレクションがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合remove(Object)
, contains(Object)
void clear()
clear
、インタフェース: Collection<E>
UnsupportedOperationException
- clearメソッドがこのセットでサポートされない場合boolean equals(Object o)
equals
、インタフェース: Collection<E>
equals
、クラス: Object
o
- このセットと等しいかどうかが比較されるオブジェクトObject.hashCode()
、HashMap
int hashCode()
Object.hashCode()
の一般規約によって要求されるように、任意の2つのセットs1とs2でs1.equals(s2)であれば、s1.hashCode()==s2.hashCode()となることが保証されます。hashCode
、インタフェース: Collection<E>
hashCode
、クラス: Object
Object.equals(Object)
, equals(Object)
default Spliterator<E> spliterator()
Spliterator
を作成します。
Spliterator
はSpliterator.DISTINCT
を報告します。実装は、追加の特性値の報告をドキュメント化する必要があります。
spliterator
、インタフェース: Collection<E>
spliterator
、インタフェース: Iterable<E>
Iterator
から遅延バインディング・スプリッテレータを作成します。スプリッテレータは、セットのイテレータのフェイルファスト・プロパティを継承します。
作成されたSpliterator
は、追加でSpliterator.SIZED
を報告します。
Spliterator
はさらにSpliterator.SUBSIZED
も報告します。Spliterator
バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Documentation Redistribution Policyも参照してください。