|
Foundation 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface Collection
「コレクション階層」のルートインタフェースです。コレクションは、その「要素」であるオブジェクトのグループを表します。コレクションによっては要素の重複を許可しますが、許可しないコレクションもあります。また、順序付けられているコレクションとそうでないコレクションがあります。SDK は、このインタフェースの「直接」の実装を一切提供しません。Set および List のような、より用途の特定されたサブインタフェースを提供します。このインタフェースは、通常は、最大限の普遍性が求められる場面でコレクションを渡したり、そのコレクションを操作するために使用されます。
「Bag」または「マルチセット」(重複要素を格納できる、順序付けのないコレクション) は、このインタフェースを直接実装する必要があります。
汎用 Collection 実装クラス (通常、サブインタフェースを介して間接的に Collection を実装する) は、2 つの「標準」コンストラクタを提供しなければいけません。空のコレクションを作成する void (引数なし) コンストラクタと、Collection 型の引数を 1 つ持ち、その引数と同じ要素で新しいコレクションを作成するコンストラクタです。したがって、後者のコンストラクタでは、ユーザーはどのコレクションでもコピーでき、希望の実装型のコレクションと完全に同じコレクションを生成できます。この規約は義務づけられているわけではありませんが (インタフェースはコンストラクタを格納できないため)、Java プラットフォームライブラリにおけるすべての汎用 Collection の実装はこの規約に準拠しています。
このコレクションがオペレーションをサポートしていない場合、このインタフェース (処理されるコレクションを修正するメソッド) に含まれている「破壊的な」メソッドは、UnsupportedOperationException をスローするように指定されています。この時、呼び出しがコレクションに影響しない場合、こうしたメソッドは、UnsupportedOperationException をスローすることができますが、必須ではありません。たとえば、追加されたコレクションが空である場合、変更不可能なコレクションで addAll(Collection)
を呼び出すと、例外をスローすることができますが、必須ではありません。
コレクションの実装には、格納できる要素に制限があるものもあります。たとえば、null 要素を禁止する実装や、null 要素の型に制限がある実装もあります。不適当な要素を追加しようとすると、通常 NullPointerException または ClassCastException のようなチェックされない例外がスローされます。不適当な要素を照会しようとすると、例外がスローされる場合や、ただ false を返す場合もあります。前の動作を禁止する実装もあれば、あとの動作を禁止する実装もあります。前の動作を表示する実装もあれば、あとの動作を表示する実装もあります。多くの場合は、コレクションへの挿入がされない不適格な要素を処理しようとすると、実装により例外がスローされたり、処理が有効になります。このインタフェースに関するそうした例外は、「任意」の仕様としてマークされます。
このインタフェースは、Java Collections Framework のメンバーです。
Set
,
List
,
Map
,
SortedSet
,
SortedMap
,
HashSet
,
TreeSet
,
ArrayList
,
LinkedList
,
Vector
,
Collections
,
Arrays
,
AbstractCollection
メソッドの概要 | |
---|---|
boolean |
add(Object o)
指定された要素がこのコレクションに格納されていることを保証します (任意のオペレーション)。 |
boolean |
addAll(Collection c)
指定されたコレクションのすべての要素をこのコレクションに追加します (任意のオペレーション)。 |
void |
clear()
このコレクションからすべての要素を削除します (任意のオペレーション)。 |
boolean |
contains(Object o)
コレクションに指定された要素がある場合に true を返します。 |
boolean |
containsAll(Collection c)
このコレクション内に、指定されたコレクションのすべての要素がある場合に true を返します。 |
boolean |
equals(Object o)
指定されたオブジェクトとこのコレクションが等しいかどうかを比較します。 |
int |
hashCode()
コレクションのハッシュコード値を返します。 |
boolean |
isEmpty()
コレクションに要素がない場合に true を返します。 |
Iterator |
iterator()
コレクションの要素の反復子を返します。 |
boolean |
remove(Object o)
指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから 1 つ削除します (任意のオペレーション)。 |
boolean |
removeAll(Collection c)
指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します (任意のオペレーション)。 |
boolean |
retainAll(Collection c)
このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します (任意のオペレーション)。 |
int |
size()
このコレクション中の要素の数を返します。 |
Object[] |
toArray()
このコレクションの要素がすべて格納されている配列を返します。 |
Object[] |
toArray(Object[] a)
このコレクション内のすべての要素を保持する配列を返します。 |
メソッドの詳細 |
---|
int size()
boolean isEmpty()
boolean contains(Object o)
o
- コレクションにあるかどうかを調べる要素
ClassCastException
- 指定された要素の型が、このコレクションと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このコレクションが null 要素をサポートしない場合 (省略可能)Iterator iterator()
Object[] toArray()
返される配列への参照をコレクションが維持しないという点で、この配列は安全です。つまり、このメソッドは、コレクションが配列に連動している場合でも新しい配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。
メソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。
Object[] toArray(Object[] a)
コレクションが指定された配列に収まり、その配列にさらに余裕がある場合 (つまり、配列がコレクションより多くの要素を持つ場合)、その配列内でコレクションの終端よりあとの要素は null に設定されます。コレクションに null 要素がないことを呼び出し側が知っている場合にだけ、この特性を利用してコレクションの長さを判断できます。
反復子によって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。
toArray メソッドと同じように、このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。さらに、このメソッドでは、出力配列の実行時の型を正確に制御できるため、環境によっては割り当ての手間を抑えることができます。
l が、文字列だけからなる List であることがわかっていると仮定します。次のコードを使うと、新しく割り当てられた String の配列にリストをダンプできます。
String[] x = (String[]) v.toArray(new String[0]);
toArray(new Object[0]) は、機能の点で toArray() と同一です。
a
- コレクションの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる
ArrayStoreException
- 指定された配列の実行時の型が、このコレクションの各要素の実行時の型のスーパータイプではない場合
NullPointerException
- 指定された配列が null である場合boolean add(Object o)
このオペレーションをサポートするコレクションでは、コレクションに追加できる要素について制限がある場合があります。たとえば、コレクションによっては、null 要素の追加が許可されないことや、追加される要素の型を制限することがあります。追加される要素に関して制限がある場合は、その Collection クラスのドキュメントに明示すべきでしょう。
その要素がすでにあるという以外の理由で特定の要素の追加を拒否する場合、コレクションは false を返すのではなく例外をスローする必要があります。これにより、この呼び出しが戻ったあとにコレクションが指定された要素を必ず格納するという不変性を保つことができます。
o
- コレクションにあるかどうかを調べる要素
UnsupportedOperationException
- このコレクションが add をサポートしない場合
ClassCastException
- 指定された要素のクラスが原因で、このコレクションに追加できなかった場合
NullPointerException
- 指定された要素が null で、このコレクションが null 要素をサポートしない場合
IllegalArgumentException
- この要素の特性が原因で、このコレクションに追加できなかった場合boolean remove(Object o)
o
- コレクションから削除される要素 (その要素がある場合)
ClassCastException
- 指定された要素の型が、このコレクションと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このコレクションが null 要素をサポートしない場合 (省略可能)
UnsupportedOperationException
- このコレクションが remove をサポートしない場合boolean containsAll(Collection c)
c
- このコレクションにあるかどうかを調べるコレクション
ClassCastException
- 指定されたコレクションの 1 つ以上の要素の型が、このコレクションと互換性がない場合 (省略可能)
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれていて、このコレクションが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合contains(Object)
boolean addAll(Collection c)
c
- コレクションに挿入される要素
UnsupportedOperationException
- このコレクションが addAll メソッドをサポートしない場合
ClassCastException
- 指定されたコレクションの要素のクラスが原因で、このコレクションに追加できなかった場合
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このコレクションが null 要素をサポートしない場合 (省略可能)。または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクションの要素の特性が原因で、このコレクションに追加できなかった場合add(Object)
boolean removeAll(Collection c)
c
- コレクションから削除される要素
UnsupportedOperationException
- このコレクションが removeAll メソッドをサポートしない場合
ClassCastException
- このコレクションの 1 つ以上の要素の型が、指定されたコレクションと互換性がない場合 (省略可能)
NullPointerException
- このコレクションに 1 つ以上の null 要素が含まれていて、このコレクションが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
,
contains(Object)
boolean retainAll(Collection c)
c
- コレクションで保持される要素
UnsupportedOperationException
- コレクションが retainAll メソッドをサポートしていない場合
ClassCastException
- このコレクションの 1 つ以上の要素の型が、指定されたコレクションと互換性がない場合 (省略可能)
NullPointerException
- このコレクションに 1 つ以上の null 要素が含まれていて、このコレクションが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
,
contains(Object)
void clear()
UnsupportedOperationException
- このコレクションが clear メソッドをサポートしない場合boolean equals(Object o)
Collection インタフェースは Object.equals の汎用規約に条項を追加しませんが、Collection を「直接」に実装する (つまり、Collection であり、Set または List ではないクラスを作成する) ときには、Object.equals をオーバーライドする場合に配慮が必要です。Object.equals をオーバーライドする必要がない場合、もっとも単純な方法は Object の実装に依存することですが、実装によっては、デフォルトの「参照比較」の代わりに「値比較」を実装する必要があることがあります。List および Set では、このような値比較が必要です。
Object.equals メソッドの一般規約によると、equals は対称的でなければいけません (つまり、b.equals(a) の場合にだけ a.equals(b))。List.equals および Set.equals の規約によると、リストはほかのリストとだけ等しくなり、セットはほかのセットとだけ等しくなります。このため、List と Set のどちらのインタフェースも実装しないコレクションクラスのカスタム equals メソッドは、このコレクションがリストまたはセットと比較された場合に false を返します。同じ論理により、Set と List の両インタフェースを正しく実装するクラスを記述することはできません。
Object
内の equals
o
- このコレクションと等しいかどうかが比較される Object
Object.equals(Object)
,
Set.equals(Object)
,
List.equals(Object)
int hashCode()
Object
内の hashCode
Object.hashCode()
,
Object.equals(Object)
|
Foundation 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。