java.util.AbstractCollection<E>
|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Object
public abstract class AbstractCollection<E>
このクラスは、Collection インタフェースのスケルトン実装を提供し、このインタフェースを実装するのに必要な作業量を最小限に抑えます。
変更不可能なコレクションを実装するには、このクラスを拡張して、iterator メソッドおよび size メソッドの実装を提供します。iterator メソッドが返す反復子は、hasNext および next を実装している必要があります。
変更可能なコレクションを実装するには、上記に加えて、このクラスの add メソッドをオーバーライドすることと (オーバーライドしなかった場合は、UnsupportedOperationException がスローされる)、iterator メソッドで返される反復子が remove メソッドを実装している必要があります。
Collection インタフェースの仕様で推奨されているように、通常は、引数なしの void コンストラクタ、および引数に Collection をとるコンストラクタを提供してください。
実装の詳細については、このクラスの abstract メソッド以外の各メソッドのドキュメントを参照してください。より効率的な実装ができるコレクションの場合は、これらのメソッドをオーバーライドしてもかまいません。
このクラスは、Java Collections Framework のメンバーです。
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)
このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します (任意のオペレーション)。 |
|
abstract int |
size()
このコレクション中の要素の数を返します。 |
|
Object[] |
toArray()
このコレクションの要素がすべて格納されている配列を返します。 |
|
|
toArray(T[] a)
このコレクション内のすべての要素を保持する配列を返します。 |
|
String |
toString()
このコレクションの文字列表現を返します。 |
|
| クラス java.lang.Object から継承されたメソッド |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| インタフェース java.util.Collection から継承されたメソッド |
|---|
equals, hashCode |
| コンストラクタの詳細 |
|---|
protected AbstractCollection()
| メソッドの詳細 |
|---|
public abstract Iterator<E> iterator()
Iterable<E> 内の iteratorCollection<E> 内の iteratorpublic abstract int size()
Collection の記述:
Collection<E> 内の sizepublic boolean isEmpty()
この実装は size() == 0 の結果を返します。
Collection<E> 内の isEmptypublic boolean contains(Object o)
この実装はコレクションの各要素について、指定された要素と等しいかどうかを順に繰り返し確認します。
Collection<E> 内の containso - コレクションにあるかどうかを調べる要素
ClassCastException - 指定した要素の型が、このコレクションと互換でない場合 (省略可能)
NullPointerException - 指定された要素が null で、このコレクションが null 要素を許容しない場合 (省略可能)public Object[] toArray()
返される配列への参照をコレクションが維持しないという点で、この配列は安全です。つまり、このメソッドは、コレクションが配列に連動している場合でも新しい配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。
メソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。
この実装は、インデックス 0 で始まり、同じ順序で、配列の連続した要素に格納されている、このコレクションの反復子によって返されるすべての要素を含む配列を返します。返される配列の長さは、コレクションが繰り返し処理時の並行変更を許可する場合と同様に、このコレクションのサイズが繰り返し処理時に変わる場合でも、反復子によって返される要素の数と等しくなります。size メソッドは、最適化のヒントとしてしか呼び出されません。反復子が異なる数の要素を返す場合でも、正しい結果が返されます。
このメソッドは、次と同等です。
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray();
Collection<E> 内の toArraypublic <T> T[] toArray(T[] a)
コレクションが指定された配列に収まり、その配列にさらに余裕がある場合 (つまり、配列がコレクションより多くの要素を持つ場合)、その配列内でコレクションの終端よりあとの要素は null に設定されます。コレクションに null 要素がないことを呼び出し側が知っている場合にだけ、この特性を利用してコレクションの長さを判断できます。
反復子によって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。
Collection.toArray() メソッドと同じように、このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。さらに、このメソッドでは、出力配列の実行時の型を正確に制御できるため、環境によっては割り当ての手間を抑えることができます。
x が、文字列だけからなるコレクションであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられた String の配列にコレクションをダンプできます。
String[] y = x.toArray(new String[0]);
toArray(new Object[0]) は、機能の点で toArray() と同一です。
この実装は、インデックス 0 で始まり、同じ順序で、配列の連続した要素に格納されている、このコレクションの反復子によって返されるすべての要素を含む配列を返します。反復子によって返される要素数が大きすぎて指定された配列に収まらない場合、このコレクションのサイズが繰り返し処理時に変わる場合でも、コレクションが繰り返し処理時に並行変更を許可している場合と同様に、反復子によって返される要素数と長さが等しい、新しく割り当てられた配列内の要素が返されます。size メソッドは、最適化のヒントとしてしか呼び出されません。反復子が異なる数の要素を返す場合でも、正しい結果が返されます。
このメソッドは、次と同等です。
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray(a);
Collection<E> 内の toArraya - コレクションの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる
ArrayStoreException - 指定された配列の実行時の型が、このコレクション内のすべての要素の実行時の型のスーパータイプではない場合
NullPointerException - 指定された配列が null である場合public boolean add(E e)
このオペレーションをサポートするコレクションでは、コレクションに追加できる要素について制限がある場合があります。たとえば、コレクションによっては、null 要素の追加が許可されないことや、追加される要素の型を制限することがあります。追加される要素に関して制限がある場合は、その Collection クラスのドキュメントに明示すべきでしょう。
その要素がすでにあるという以外の理由で特定の要素の追加を拒否する場合、コレクションは false を返すのではなく例外をスローする必要があります。これにより、この呼び出しが戻ったあとにコレクションが指定された要素を必ず格納するという不変性を保つことができます。
この実装は、常に UnsupportedOperationException をスローします。
Collection<E> 内の adde - コレクションにあるかどうかを調べる要素
UnsupportedOperationException - add オペレーションがこのコレクションでサポートされない場合
ClassCastException - 指定された要素のクラスが原因で、コレクションに要素を追加できない場合
NullPointerException - 指定された要素が null で、このコレクションが null 要素を許容しない場合
IllegalArgumentException - 要素のある特性が原因で、このコレクションに要素を追加できない場合
IllegalStateException - 挿入制限のためにこの時点で要素を追加できない場合public boolean remove(Object o)
この実装は、コレクションの内容を次々調べ、指定された要素を探します。要素があれば、反復子の remove メソッドを使ってコレクションから要素を削除します。
このコレクションの iterator メソッドが返す反復子が remove メソッドを実装せず、指定されたオブジェクトがこのコレクション内にある場合、この実装は UnsupportedOperationException をスローします。
Collection<E> 内の removeo - コレクションから削除される要素 (その要素が存在する場合)
UnsupportedOperationException - remove オペレーションがこのコレクションでサポートされない場合
ClassCastException - 指定した要素の型が、このコレクションと互換でない場合 (省略可能)
NullPointerException - 指定された要素が null で、このコレクションが null 要素を許容しない場合 (省略可能)public boolean containsAll(Collection<?> c)
この実装は指定されたコレクションの内容を次々調べ、反復子によって返された各要素について、このコレクションに含まれるかどうかを順番に確認します。すべての要素がこのコレクションにある場合は true を返し、そうでない場合は false を返します。
Collection<E> 内の containsAllc - このコレクションにあるかどうかを調べるコレクション
ClassCastException - 指定されたコレクションの 1 つ以上の要素の型が、このコレクションと互換でない場合 (省略可能)
NullPointerException - 指定されたコレクションに 1 つ以上の null 要素が含まれており、このコレクションが null 要素を許可しない場合 (省略可能)。または指定されたコレクションが null の場合contains(Object)public boolean addAll(Collection<? extends E> c)
この実装は、指定されたコレクションに対して反復を行い、反復子が返すオブジェクトをこのコレクションに順に追加していく操作を繰り返します。
指定されたコレクションが空でない場合は、add メソッドがオーバーライドされないかぎり、この実装は UnsupportedOperationException をスローします。
Collection<E> 内の addAllc - コレクションに追加される要素を含むコレクション
UnsupportedOperationException - addAll オペレーションがこのコレクションでサポートされない場合
ClassCastException - 指定されたコレクションの要素のクラスが原因で、このコレクションに追加できなかった場合
NullPointerException - 指定されたコレクション内に null 要素が含まれ、このコレクションが null 要素を許可しない場合。または指定されたコレクションが null の場合
IllegalArgumentException - 指定されたコレクションの要素のある特性が原因で、このコレクションに要素を追加できなかった場合
IllegalStateException - 挿入制限のため、この時点で一部の要素を追加できない場合add(Object)public boolean removeAll(Collection<?> c)
この実装はこのコレクションの内容を次々調べ、反復子によって返された各要素について、指定されたコレクションに含まれるかどうかを順番に確認します。そのような要素があれば、反復子の remove メソッドを使ってこのコレクションから削除します。
iterator メソッドで返された反復子が remove メソッドを実装せず、指定されたコレクションに共通する要素が 1 つでもこのコレクション内にある場合は、この実装は UnsupportedOperationException をスローします。
Collection<E> 内の removeAllc - このコレクションから削除される要素を含むコレクション
UnsupportedOperationException - removeAll メソッドがこのコレクションでサポートされない場合
ClassCastException - このコレクションの 1 つ以上の要素の型が、指定されたコレクションと互換でない場合 (省略可能)
NullPointerException - このコレクション内に 1 つ以上の null 要素が含まれており、指定されたコレクションが null 要素をサポートしない場合 (省略可能)。または指定されたコレクションが null の場合remove(Object),
contains(Object)public boolean retainAll(Collection<?> c)
この実装はこのコレクションの内容を次々調べ、反復子によって返された各要素について、指定されたコレクションに含まれるかどうかを順番に確認します。含まれない要素があれば、反復子の remove メソッドを使ってこのコレクションから削除します。
iterator メソッドで返された反復子が remove メソッドを実装せず、指定されたコレクションに含まれない要素が 1 つでもこのコレクション内にある場合は、この実装は UnsupportedOperationException をスローします。
Collection<E> 内の retainAllc - このコレクションで保持される要素を含むコレクション
UnsupportedOperationException - retainAll オペレーションがこのコレクションでサポートされない場合
ClassCastException - このコレクションの 1 つ以上の要素の型が、指定されたコレクションと互換でない場合 (省略可能)
NullPointerException - このコレクション内に 1 つ以上の null 要素が含まれており、指定されたコレクションが null 要素を許可しない場合 (省略可能)。または指定されたコレクションが null の場合remove(Object),
contains(Object)public void clear()
この実装はコレクションに対して、Iterator.remove オペレーションを使用して各要素を削除する操作を繰り返します。ほとんどの実装では、このメソッドをオーバーライドした方がより効率的です。
このコレクションの iterator メソッドで返される反復子が remove メソッドを実装せず、このコレクションが空でない場合、この実装は UnsupportedOperationException をスローします。
Collection<E> 内の clearUnsupportedOperationException - clear オペレーションがこのコレクションでサポートされない場合public String toString()
String.valueOf(Object) を実行したかのように文字列に変換されます。
Object 内の toString
|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。