インタフェースSequencedCollection<E>

型パラメータ:

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

すべてのスーパー・インタフェース:

Collection<E>, Iterable<E>

既知のすべてのサブインタフェース:

BlockingDeque<E>, Deque<E>, List<E>, NavigableSet<E>, SequencedSet<E>, SortedSet<E>

既知のすべての実装クラス:

AbstractList, AbstractSequentialList, ArrayDeque, ArrayList, AttributeList, ConcurrentLinkedDeque, ConcurrentSkipListSet, CopyOnWriteArrayList, LinkedBlockingDeque, LinkedHashSet, LinkedList, RoleList, RoleUnresolvedList, Stack, TreeSet, Vector

public interface SequencedCollection<E> extends Collection<E>

検出順序が明確に定義され、両端での操作をサポートし、逆転可能なコレクション。 順序付けられたコレクションの要素には「見つける」があり、概念上、要素には最初の要素から最後の要素までの線形配列があります。 2つの要素がある場合、1つの要素が(最初の要素に近い)の前または(最後の要素に近い)の後に他方の要素になります。

(この定義は、コンピュータのメモリー内のロケーションなど、要素の物理的なロケーション設定を意味するものではありません。)

Collectionインタフェースから継承されたいくつかのメソッドは、このコレクションの出現順序に従って要素を操作するために必要です。 たとえば、iteratorメソッドは、最初の要素から開始して、連続する要素から最後の要素まで続く要素を提供します。 検出順序で要素を処理するために必要なその他のメソッドには、次のものがあります: forEach、parallelStream、spliterator、stream、およびtoArrayメソッドのすべてのオーバーロード。

このインタフェースには、コレクションの両端に要素を追加、取得および削除するメソッドがあります。

このインタフェースは、このコレクションの逆順viewを提供するreversedメソッドも定義します。 順序の逆のビューでは、後任者と前任者の概念と同様に、最初と最後の概念が反転します。 このコレクションの最初の要素は、逆順ビューの最後の要素であり、その逆も同様です。 このコレクションの一部の要素の後継は、戻し処理されたビューの先行作業です。その逆も同様です。 コレクションの出現順序を尊重するすべてのメソッドは、検出順序が反転しているかのように動作します。 たとえば、逆方向ビューのCollection.iterator()メソッドは、このコレクションの最後の要素から最初の要素までの順に要素をレポートします。 reversedメソッドの可用性と、適用可能なすべてのメソッドの順序付けセマンティクスへの影響により、このコレクションの要素を順方向または逆順で簡単に反復、検索、コピーおよびストリーミングできます。

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

APIのノート:

このインタフェースでは、equalsおよびhashCodeメソッドの要件は課されません。これは、サブインタフェースListおよびSequencedSet (Setから要件を継承)によって課される要件が競合するためです。 詳細は、Collection.equalsおよびCollection.hashCodeの仕様を参照してください。

導入されたバージョン:

21

メソッドのサマリー

修飾子と型	メソッド	説明
default void	addFirst(E e)	このコレクションの最初の要素として要素を追加します (オプションの操作)。
default void	addLast(E e)	このコレクションの最後の要素として要素を追加します (オプションの操作)。
default E	getFirst()	このコレクションの最初の要素を取得します。
default E	getLast()	このコレクションの最後の要素を取得します。
default E	removeFirst()	このコレクションの最初の要素を削除して返します(オプションの操作)。
default E	removeLast()	このコレクションの最後の要素を削除して返します(オプションの操作)。
SequencedCollection<E>	reversed()	このコレクションの逆順viewを返します。

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

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

修飾子と型	メソッド	説明
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()	このコレクションに要素がない場合にtrueを返します。
Iterator<E>	iterator()	コレクションの要素のイテレータを返します。
default Stream<E>	parallelStream()	このコレクションをソースとして、潜在的に並列のStreamを返します。
boolean	remove(Object o)	指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから1つ削除します(オプションの操作)。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
default boolean	removeIf(Predicate<? super E> filter)	指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
int	size()	このコレクション中の要素の数を返します。
default Spliterator<E>	spliterator()	このコレクション内の要素に対するSpliteratorを作成します。
default Stream<E>	stream()	このコレクションをソースとして使用して、逐次的なStreamを返します。
Object[]	toArray()	このコレクションの要素がすべて格納されている配列を返します。
default <T> T[]	toArray(IntFunction<T[]> generator)	指定されたgenerator関数を使用してこのコレクションのすべての要素を含む配列を返し、返された配列を割り当てます。
<T> T[]	toArray(T[] a)	このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。

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

forEach

修飾子と型	メソッド	説明
default void	forEach(Consumer<? super E> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。

メソッドの詳細

reversed

SequencedCollection<E> reversed()

このコレクションの逆順viewを返します。 返されるビュー内の要素の出現順序は、このコレクション内の要素の出現順序の逆です。 逆の順序付けは、返されるビューのビュー・コレクションに含まれるすべての順序依存操作に影響します。 コレクション実装でこのビューの変更が許可されている場合、ベースとなるコレクションへの変更"ライトスルー"。 実装によっては、基礎となるコレクションに対する変更が、この逆方向ビューに表示される場合と表示されない場合があります。

戻り値:

このコレクションの逆順表示

addFirst

default void addFirst(E e)

このコレクションの最初の要素として要素を追加します (オプションの操作)。 この操作が正常に完了すると、指定された要素はこのコレクションのメンバーになり、発生順に最初の要素になります。

実装要件:

このインタフェースの実装では、常にUnsupportedOperationExceptionがスローされます。

パラメータ:

e - 追加する要素

スロー:

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

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない場合

addLast

default void addLast(E e)

このコレクションの最後の要素として要素を追加します (オプションの操作)。 この操作が正常に完了すると、指定された要素はこのコレクションのメンバーになり、最後の要素が出現順になります。

実装要件:

このインタフェースの実装では、常にUnsupportedOperationExceptionがスローされます。

パラメータ:

e - 追加する要素。

スロー:

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

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない場合

getFirst

default E getFirst()

このコレクションの最初の要素を取得します。

実装要件:

このインタフェースの実装では、このコレクションのイテレータを取得し、イテレータのnextメソッドをコールして要素を取得します。 スローされたNoSuchElementExceptionは伝播されます。 それ以外の場合は、エレメントが返されます。

戻り値:

取得された要素

スロー:

NoSuchElementException - このコレクションが空の場合

getLast

default E getLast()

このコレクションの最後の要素を取得します。

実装要件:

このインタフェースの実装では、このコレクションの逆方向ビューのイテレータを取得し、イテレータのnextメソッドをコールして要素を取得します。 スローされたNoSuchElementExceptionは伝播されます。 それ以外の場合は、エレメントが返されます。

戻り値:

取得された要素

スロー:

NoSuchElementException - このコレクションが空の場合

removeFirst

default E removeFirst()

このコレクションの最初の要素を削除して返します(オプションの操作)。

実装要件:

このインタフェースの実装では、このコレクションのイテレータを取得し、イテレータのnextメソッドをコールして要素を取得します。 スローされたNoSuchElementExceptionは伝播されます。 次に、イテレータのremoveメソッドをコールします。 スローされたUnsupportedOperationExceptionは伝播されます。 次に、要素を返します。

戻り値:

削除される要素

スロー:

NoSuchElementException - このコレクションが空の場合

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない場合

removeLast

default E removeLast()

このコレクションの最後の要素を削除して返します(オプションの操作)。

実装要件:

このインタフェースの実装では、このコレクションの逆方向ビューのイテレータを取得し、イテレータのnextメソッドをコールして要素を取得します。 スローされたNoSuchElementExceptionは伝播されます。 次に、イテレータのremoveメソッドをコールします。 スローされたUnsupportedOperationExceptionは伝播されます。 次に、要素を返します。

戻り値:

削除される要素

スロー:

NoSuchElementException - このコレクションが空の場合

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない場合