クラスAbstractCollection<E>

java.lang.Object

java.util.AbstractCollection<E>

型パラメータ:

E - このコレクションの要� のタイプ

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

Iterable<E>, Collection<E>

直系の既知のサブクラス:

AbstractList, AbstractQueue, AbstractSet, ArrayDeque, ConcurrentLinkedDeque

public abstract class AbstractCollection<E> extends Object implements Collection<E>

このクラスは、このインタフェースの実装に必要な労力を最小限に抑えるために、Collectionインタフェースのスケルトン実装を提供します。

変更不可能なコレクションを実装するには、プログラマは、このクラスを拡張して、iteratorおよびsizeメソッドの実装を提供する� けで済みます。 (iteratorメソッドによって返されるイテレータは、hasNextおよびnextを実装する必要があります。)

変更可能なコレクションを実装するには、プログラマはさらにこのクラスのaddメソッド(それ以外の� �合はUnsupportedOperationExceptionをスロー)をオーバーライドし、iteratorメソッドから戻されるイテレータはさらにそのremoveメソッドを実装する必要があります。

プログラマは、通常、Collectionインタフェース仕様の推奨事� �に従って、void (引数なし)およびCollectionコンストラクタを指定する必要があります。

実装の詳細については、このクラスの抽象メソッド以外の各メソッドのドキュメントを参照してく� さい。 より効率的な実装ができるコレクションの� �合は、これらのメソッドをオーバーライドしてもかまいません。

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

導入されたバージョン:

1.2

関連� �目:

• Collection

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

コンストラクタ

修飾子	コンストラクタ	説明
protected	AbstractCollection()	唯一のコンストラクタです。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(E e)	指定された要� がこのコレクションに� �納されていることを保証します(オプションの操作)。
boolean	addAll(Collection<? extends E> c)	指定されたコレクションのすべての要� をこのコレクションに追� します(オプションの操作)。
void	clear()	このコレクションからすべての要� を削除します(オプションの操作)。
boolean	contains(Object o)	このコレクションに指定した要� が含まれている� �合は、trueを返します。
boolean	containsAll(Collection<?> c)	指定したコレクションのすべての要� がこのコレクションに含まれている� �合、trueを返します。
boolean	isEmpty()	このコレクションに要� がない� �合にtrueを返します。
abstract Iterator<E>	iterator()	このコレクション中の要� に関係するイテレータを返します。
boolean	remove(Object o)	指定された要� のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから1つ削除します(オプションの操作)。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも� �納されているこのコレクションのすべての要� を削除します(オプションの操作)。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに� �納されている要� � けを保持します(オプションの操作)。
Object[]	toArray()	このコレクションの要� がすべて� �納されている配列を返します。
<T> T[]	toArray(T[] a)	このコレクション内のすべての要� を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。
String	toString()	このコレクションの文字列表現を返します。

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースjava.util.Collectionで宣言されたメソッド

equals, hashCode, parallelStream, removeIf, size, spliterator, stream, toArray

インタフェースjava.lang.Iterableで宣言されたメソッド

forEach

コンストラクタの詳細

AbstractCollection

protected AbstractCollection()

唯一のコンストラクタです。 (サブクラスのコンストラクタによる呼出し用で、通常は暗黙的に呼び出されます。)

メソッドの詳細

iterator

public abstract Iterator<E> iterator()

このコレクション中の要� に関係するイテレータを返します。

定義:

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

定義:

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

戻り値:

このコレクション中の要� に関係するイテレータ

isEmpty

public boolean isEmpty()

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

定義:

isEmpty、インタフェースCollection<E>

実装要件:

この実装はsize() == 0を返します。

戻り値:

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

contains

public boolean contains(Object o)

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

定義:

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

実装要件:

この実装はコレクションの各要� について、指定された要� と等しいかどうかを� �に繰返し確認します。

パラメータ:

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

戻り値:

このコレクションに指定した要� が含まれている� �合はtrue

スロー:

ClassCastException - 指定された要� の型が、このコレクションと互換でない� �合(オプション)

NullPointerException - 指定された要� がnullで、このコレクションがnull要� を許可しない� �合(オプション)

toArray

public Object[] toArray()

このコレクションの要� がすべて� �納されている配列を返します。 イテレータによって要� が返される� �序をコレクションが保証する� �合、このメソッドは同じ� �序で要� を返さなければなりません。 返される配列の「ランタイ� ・コンポーネント・タイプ」はObjectです。

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

定義:

toArray、インタフェースCollection<E>

実装要件:

この実装は、インデックス0で始まり、同じ� �序で、配列の連続した要� に� �納されている、このコレクションのイテレータによって返されるすべての要� を含む配列を返します。 返される配列の長さは、コレクションが反復処理時の並行変更を許可する� �合と同様に、このコレクションのサイズが反復処理時に変わる� �合でも、イテレータによって返される要� の数と等しくなります。 sizeメソッドは、最適化のヒントとしてしか呼び出されません。イテレータが異なる数の要� を返す� �合でも、正しい結果が返されます。

このメソッドは、次と同等です。

 
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray();
 

戻り値:

「ランタイ� ・コンポーネント・タイプ」がObjectの配列。このコレクションのすべての要� を含む

toArray

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

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

このコレクションが(つまり、配列にはこのコレクションより多くの要� があります)の余裕のある指定された配列に収まる� �合、コレクションの終端の直後の配列の要� はnullに設定されます。 (これは、このコレクションにnull要� が含まれていないことをコール元が認識している� �合に、このコレクションonlyの長さを決定する際に役立ちます。)

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

定義:

toArray、インタフェースCollection<E>

実装要件:

この実装は、インデックス0で始まり、同じ� �序で、配列の連続した要� に� �納されている、このコレクションのイテレータによって返されるすべての要� を含む配列を返します。 イテレータによって返される要� 数が大きすぎて指定された配列に収まらない� �合、このコレクションのサイズが反復処理時に変わる� �合でも、コレクションが反復処理時に並行変更を許可している� �合と同様に、イテレータによって返される要� 数と長さが等しい、新しく割り当てられた配列内の要� が返されます。 sizeメソッドは、最適化のヒントとしてしか呼び出されません。イテレータが異なる数の要� を返す� �合でも、正しい結果が返されます。

このメソッドは、次と同等です。

 
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray(a);
 

型パラメータ:

T - コレクションを� �納する配列のコンポーネント型

パラメータ:

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

戻り値:

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

スロー:

ArrayStoreException - このコレクション内の要� の実行時の型が、指定された配列の「ランタイ� ・コンポーネント・タイプ」に代入可能でない� �合

NullPointerException - 指定された配列がnullである� �合

add

public boolean add(E e)

指定された要� がこのコレクションに� �納されていることを保証します(オプションの操作)。 このコレクションがコールの結果として変更された� �合は、trueを返します。 (このコレクションで重複が許可されず、指定された要� がすでに含まれている� �合は、falseを返します。)

このオペレーションをサポートするコレクションでは、コレクションに追� できる要� について制限がある� �合があります。 特に、一部のコレクションではnull要� の追� が拒否され、その他のコレクションでは追� できる要� のタイプに制限が課されます。 追� される要� に関して制限がある� �合は、そのCollectionクラスのドキュメントに明示すべきでしょう。

コレクションにすでに要� が含まれている理由以外で特定の要� の追� が拒否された� �合、例外(falseを返すのではなく)をスローする必要があります。 これにより、この呼出しが戻ったあとにコレクションが指定された要� を必ず� �納するという不変性を保つことができます。

定義:

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

実装要件:

この実装は、常にUnsupportedOperationExceptionをスローします。

パラメータ:

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

戻り値:

コールの結果としてこのコレクションが変更された� �合、true

スロー:

UnsupportedOperationException - add操作がこのコレクションでサポートされていない� �合

ClassCastException - 指定された要� のクラスが原� で、このコレクションにその要� を追� できない� �合

NullPointerException - 指定された要� がnullで、このコレクションがnull要� を許可しない� �合

IllegalArgumentException - 要� のあるプロパティが原� で、このコレクションに要� を追� できない� �合

IllegalStateException - 挿入制限のため、この時点で要� を追� できない� �合

remove

public boolean remove(Object o)

指定された要� のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから1つ削除します(オプションの操作)。 より正式には、要� eを削除して、このコレクションにそのような要� が1つ以上含まれている� �合はObjects.equals(o, e)にします。 このコレクションに指定した要� (このコレクションがコールの結果として変更された� �合、または同等)が含まれている� �合は、trueを返します。

定義:

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

実装要件:

この実装は、コレクションの内容を次々調べ、指定された要� を探します。 要� があれば、イテレータのremoveメソッドを使ってコレクションから要� を削除します。

このコレクションのイテレータ・メソッドによって返されるイテレータがremoveメソッドを実装せず、このコレクションに指定したオブジェクトが含まれている� �合、この実装はUnsupportedOperationExceptionをスローすることに注意してく� さい。

パラメータ:

o - このコレクションから削除される要� (その要� が存在する� �合)

戻り値:

この呼出しの結果として要� が削除された� �合はtrue

スロー:

UnsupportedOperationException - remove操作がこのコレクションでサポートされていない� �合

ClassCastException - 指定された要� の型が、このコレクションと互換でない� �合(オプション)

NullPointerException - 指定された要� がnullで、このコレクションがnull要� を許可しない� �合(オプション)

containsAll

public boolean containsAll(Collection<?> c)

指定したコレクションのすべての要� がこのコレクションに含まれている� �合、trueを返します。

定義:

containsAll、インタフェースCollection<E>

実装要件:

この実装は指定されたコレクションの内容を次々調べ、イテレータによって返された各要� について、このコレクションに含まれるかどうかを� �番に確認します。 すべての要� にtrueが含まれている� �合は、falseが返されます。

パラメータ:

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

戻り値:

このコレクションに指定したコレクションのすべての要� が含まれている� �合、true

スロー:

ClassCastException - 指定されたコレクションの1つ以上の要� の型が、このコレクションと互換でない� �合(オプション)

NullPointerException - 指定したコレクションに1つ以上のnull要� が含まれ、このコレクションでnull要� (optional)が許可されない� �合、または指定されたコレクションがnullの� �合。

関連� �目:

• contains(Object)

addAll

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

指定されたコレクションのすべての要� をこのコレクションに追� します(オプションの操作)。 オペレーションの進行中に、指定されたコレクションが変更された� �合の、このオペレーションの動作は定義されていません。 したがって、指定されたコレクションがこのコレクション自身であり、このコレクションが空ではない� �合、この呼出しの動作は定義されていません。 指定したコレクションに「見つける」が定義されている� �合、その要� の処理は通常、その� �序で行われます。

定義:

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

実装要件:

この実装は、指定されたコレクションに対して反復を行い、イテレータが返すオブジェクトをこのコレクションに� �に追� していく操作を繰り返します。

この実装では、addが(指定したコレクションが空でないと仮定しています)にオーバーライドされないかぎり、UnsupportedOperationExceptionがスローされます。

パラメータ:

c - このコレクションに追� される要� を含むコレクション

戻り値:

コールの結果としてこのコレクションが変更された� �合、true

スロー:

UnsupportedOperationException - addAll操作がこのコレクションでサポートされていない� �合

ClassCastException - 指定されたコレクションの要� のクラスが原� で、このコレクションにその要� を追� できない� �合

NullPointerException - 指定されたコレクション内にnull要� が含まれ、このコレクションがnull要� を許可しない� �合。または指定されたコレクションがnullの� �合

IllegalArgumentException - 指定されたコレクションの要� のあるプロパティが原� で、このコレクションにその要� を追� できない� �合

IllegalStateException - 挿入制限のため、この時点で一部の要� を追� できない� �合

関連� �目:

• add(Object)

removeAll

public boolean removeAll(Collection<?> c)

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

定義:

removeAll、インタフェースCollection<E>

実装要件:

この実装はこのコレクションの内容を次々調べ、イテレータによって返された各要� について、指定されたコレクションに含まれるかどうかを� �番に確認します。 含まれている� �合は、イテレータのremoveメソッドを使用してこのコレクションから削除されます。

iteratorメソッドによって返されるイテレータがremoveメソッドを実装せず、このコレクションに指定したコレクションと共通の1つ以上の要� が含まれている� �合、この実装はUnsupportedOperationExceptionをスローすることに注意してく� さい。

パラメータ:

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

戻り値:

コールの結果としてこのコレクションが変更された� �合、true

スロー:

UnsupportedOperationException - removeAll操作がこのコレクションでサポートされていない� �合

ClassCastException - このコレクション内の1つ以上の要� の型が、指定されたコレクションと互換でない� �合(オプション)

NullPointerException - このコレクションに1つ以上のnull要� が含まれ、指定したコレクションがnull要� (optional)をサポートしていない� �合、または指定されたコレクションがnullの� �合

関連� �目:

• remove(Object)
• contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

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

定義:

retainAll、インタフェースCollection<E>

実装要件:

この実装はこのコレクションの内容を次々調べ、イテレータによって返された各要� について、指定されたコレクションに含まれるかどうかを� �番に確認します。 含まれていない� �合は、イテレータのremoveメソッドを使用してこのコレクションから削除されます。

iteratorメソッドによって返されるイテレータがremoveメソッドを実装せず、このコレクションに指定したコレクションに存在しない1つ以上の要� が含まれている� �合、この実装はUnsupportedOperationExceptionをスローすることに注意してく� さい。

パラメータ:

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

戻り値:

コールの結果としてこのコレクションが変更された� �合、true

スロー:

UnsupportedOperationException - retainAll操作がこのコレクションでサポートされていない� �合

ClassCastException - このコレクション内の1つ以上の要� の型が、指定されたコレクションと互換でない� �合(オプション)

NullPointerException - このコレクションに1つ以上のnull要� が含まれ、指定したコレクションでnull要� (optional)が許可されていない� �合、または指定されたコレクションがnullの� �合

関連� �目:

• remove(Object)
• contains(Object)

clear

public void clear()

このコレクションからすべての要� を削除します(オプションの操作)。 このメソッドが戻ると、コレクションは空になります。

定義:

clear、インタフェースCollection<E>

実装要件:

この実装は、このコレクションに対して反復処理を行い、Iterator.remove操作を使用して各要� を削除します。 ほとんどの実装では、このメソッドをオーバーライドした方がより効率的です。

このコレクションのiteratorメソッドによって返されるイテレータがremoveメソッドを実装せず、このコレクションが空でない� �合、この実装はUnsupportedOperationExceptionをスローすることに注意してく� さい。

スロー:

UnsupportedOperationException - clear操作がこのコレクションでサポートされていない� �合

toString

public String toString()

このコレクションの文字列表現を返します。 文字列表現は、イテレータによって返される� �序でコレクションの要� のリストで構成され、大カッコ("[]")で囲みます。 隣接する要� は、文字", " (カンマと空白文字)によって区切られます。 要� は、String.valueOf(Object)により文字列に変換されます。

オーバーライド:

toString、クラスObject

戻り値:

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