|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface Set<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 o)
指定された要素がセット内になかった場合、セットに追加します (任意のオペレーション)。 |
|
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()
セット内の要素数 (カーディナリティ) を返します。 |
|
Object[] |
toArray()
セット内のすべての要素が格納されている配列を返します。 |
|
|
toArray(T[] a)
セット内のすべて要素を格納している配列を返します。 |
メソッドの詳細 |
---|
int size()
Collection<E>
内の size
boolean isEmpty()
Collection<E>
内の isEmpty
boolean contains(Object o)
(o==null ? e==null : o.equals(e))
に該当する要素 e
がある場合にだけ true を返します。
Collection<E>
内の contains
o
- セットにあるかどうかを調べる要素
ClassCastException
- 指定された要素の型が、このセットと互換でない場合 (任意のオプション)
NullPointerException
- 指定された要素が null で、このセットが null 要素をサポートしない場合 (任意のオプション)Iterator<E> iterator()
Collection<E>
内の iterator
Iterable<E>
内の iterator
Object[] toArray()
Collection<E>
内の toArray
<T> T[] toArray(T[] a)
Collection<E>
内の toArray
a
- セットの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる
ArrayStoreException
- a の実行時の型が、セット内の各要素の実行時の型のスーパータイプでない場合
NullPointerException
- 指定された配列が null である場合boolean add(E o)
(o==null ? e==null : o.equals(e))
に該当する要素 e
がなかった場合は、指定された要素 o
をセットに追加します。セット内にすでに指定された要素がある場合、呼び出しはセットを変更せずに false を返します。このため、コンストラクタについての制約との組み合わせにより、セットが重複要素を持たないことを保証します。この規定は、セットがすべての要素を受け付けなければならないことを意味するわけではありません。つまり、セットでは、null を含む任意の要素の追加を拒否したり、例外をスローすることを任意に指定できます (Collection.add の仕様を参照)。セットの各実装では、セットが持つことのできる要素についての制約を明記するようにしてください。
Collection<E>
内の add
o
- セットに追加される要素
UnsupportedOperationException
- セットが add メソッドをサポートしていない場合
ClassCastException
- 指定された要素のクラスのために、セットに要素を追加できない場合
NullPointerException
- 指定された要素が null で、このセットが null 要素をサポートしない場合
IllegalArgumentException
- この要素の特定の特性のために、セットに要素を追加できない場合boolean remove(Object o)
(o==null ? e==null : o.equals(e))
に該当する要素 e
があった場合は、それを削除します。指定された要素がセット内にあった場合 (セットが呼び出しの結果として変更された場合) は、true を返します。呼び出しが復帰したあとは、セットは指定された要素を持っていません。
Collection<E>
内の remove
o
- セットにあれば削除されるオブジェクト
ClassCastException
- 指定された要素の型が、このセットと互換でない場合 (任意のオプション)
NullPointerException
- 指定された要素が null で、このセットが null 要素をサポートしない場合 (任意のオプション)
UnsupportedOperationException
- セットが remove メソッドをサポートしていない場合boolean containsAll(Collection<?> c)
Collection<E>
内の containsAll
c
- このセットにあるかどうかを調べるコレクション
ClassCastException
- 指定されたコレクションの 1 つまたは複数の要素の型が、このセットと互換でない場合 (任意のオプション)
NullPointerException
- 指定されたコレクションが 1 つまたは複数のnull 要素を含み、このセットが null 要素をサポートしない場合 (任意のオプション)
NullPointerException
- 指定されたコレクションが null である場合contains(Object)
boolean addAll(Collection<? extends E> c)
Collection<E>
内の addAll
c
- 要素がセットに追加されるコレクション
UnsupportedOperationException
- セットが addAll メソッドをサポートしていない場合
ClassCastException
- 指定されたコレクションの要素のクラスが原因で、その要素をセットに追加できない場合
NullPointerException
- 指定されたコレクション内に 1 つまたは複数の null 要素が含まれず、このセットが null 要素をサポートしない場合。または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクションの要素の特性が原因で、その要素をセットに追加できない場合add(Object)
boolean retainAll(Collection<?> c)
Collection<E>
内の retainAll
c
- セットが保持する要素を定義するコレクション
UnsupportedOperationException
- コレクションが retainAll メソッドをサポートしていない場合
ClassCastException
- このコレクションの 1 つまたは複数の要素の型が、指定されたセットと互換でない場合 (任意のオプション)
NullPointerException
- このセットが null 要素を含み、指定されたコレクションが null 要素をサポートしない場合 (任意のオプション)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
boolean removeAll(Collection<?> c)
Collection<E>
内の removeAll
c
- どの要素がセットから削除されるかを定義するコレクション
UnsupportedOperationException
- このコレクションが removeAll メソッドをサポートしない場合
ClassCastException
- このコレクションの 1 つまたは複数の要素の型が、指定されたセットと互換でない場合 (任意のオプション)
NullPointerException
- このセットが null 要素を含み、指定されたコレクションが null 要素をサポートしない場合 (任意のオプション)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
void clear()
Collection<E>
内の clear
UnsupportedOperationException
- セットが clear メソッドをサポートしていない場合boolean equals(Object o)
Collection<E>
内の equals
Object
内の equals
o
- このセットと等しいかどうかが比較される Object
Object.hashCode()
,
Hashtable
int hashCode()
s1
と s2
で s1.equals(s2)
の場合に s1.hashCode()==s2.hashCode()
になることが保証されます。
Collection<E>
内の hashCode
Object
内の hashCode
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。