compact1, compact2, compact3

java.util

クラスArrayDeque<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.ArrayDeque<E>

型パラメータ:

E - このコレクション内に存在する要素の型

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

Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, Queue<E>

public class ArrayDeque<E>
extends AbstractCollection<E>
implements Deque<E>, Cloneable, Serializable

Dequeインタフェースのサイズ変更可能な配列の実装です。配列の両端キューに容量制限はなく、使用量をサポートするために必要に応じて大きくなります。それらはスレッドセーフではありません。外部の同期化がない場合、複数のスレッドによる並行アクセスはサポートされません。null要素は禁止されています。このクラスは通常、スタックとして使われるときはStackよりも高速で、キューとして使われるときはLinkedListよりも高速です。

ほとんどのArrayDequeオペレーションは、一定の償却時間で実行されます。例外には、remove、removeFirstOccurrence、removeLastOccurrence、contains、iterator.remove()、および一括オペレーションがあり、これらはすべて要素の数に比例する時間で実行されます。

このクラスのiteratorメソッドによって返されるイテレータは、フェイルファストです。イテレータの作成後に、イテレータ自体のremoveメソッド以外の方法で両端キューが変更されると、イテレータは通常ConcurrentModificationExceptionをスローします。このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。

通常、非同期の並行変更がある場合、確かな保証を行うことは不可能なので、イテレータのフェイルファストの動作を保証することはできません。フェイルファスト・イテレータは、ベスト・エフォート・ベースでConcurrentModificationExceptionをスローします。したがって、正確を期すためにこの例外に依存するプログラムを書くことは誤りです。イテレータのフェイルファストの動作はバグを検出するためにのみ使用すべきです。

このクラスとそのイテレータは、CollectionおよびIteratorインタフェースのオプションメソッドすべてを実装します。

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

導入されたバージョン:

1.6

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
ArrayDeque() 16個の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。
ArrayDeque(Collection<? extends E> c) 指定されたコレクションのイテレータが返す順序で、その要素を格納する両端キューを作成します。
ArrayDeque(int numElements) 指定された数の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。

メソッドのサマリー

修飾子と型	メソッドと説明
boolean	add(E e) 指定された要素をこの両端キューの末尾に挿入します。
void	addFirst(E e) 指定された要素をこの両端キューの先頭に挿入します。
void	addLast(E e) 指定された要素をこの両端キューの末尾に挿入します。
void	clear() すべての要素を両端キューから削除します。
ArrayDeque<E>	clone() この両端キューの複製を返します。
boolean	contains(Object o) 指定された要素がこの両端キューに含まれている場合にtrueを返します。
Iterator<E>	descendingIterator() この両端キュー内の要素を逆順で反復処理するイテレータを返します。
E	element() この両端キューで表されるキューの先頭を取得しますが、削除しません。
E	getFirst() この両端キューの最初の要素を取得しますが、削除はしません。
E	getLast() この両端キューの最後の要素を取得しますが、削除はしません。
boolean	isEmpty() この両端キューに要素が含まれていない場合にtrueを返します。
Iterator<E>	iterator() 両端キューの要素のイテレータを返します。
boolean	offer(E e) 指定された要素をこの両端キューの末尾に挿入します。
boolean	offerFirst(E e) 指定された要素をこの両端キューの先頭に挿入します。
boolean	offerLast(E e) 指定された要素をこの両端キューの末尾に挿入します。
E	peek() この両端キューによって表されるキューの先頭を取得しますが、削除しません。両端キューが空の場合はnullを返します。
E	peekFirst() この両端キューの最初の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。
E	peekLast() この両端キューの最後の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。
E	poll() この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得および削除します。両端キューが空の場合は、nullを返します。
E	pollFirst() この両端キューの最初の要素を取得および削除します。両端キューが空の場合はnullを返します。
E	pollLast() この両端キューの最後の要素を取得および削除します。両端キューが空の場合はnullを返します。
E	pop() この両端キューで表されるスタックに要素をポップします。
void	push(E e) この両端キューで表されるスタックに要素を入れます。
E	remove() この両端キューが表すキューの先頭を取得して削除します。
boolean	remove(Object o) 指定された要素の単一のインスタンスを、この両端キューから削除します。
E	removeFirst() この両端キューの最初の要素を取得して削除します。
boolean	removeFirstOccurrence(Object o) 両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最初に出現したものを削除します。
E	removeLast() この両端キューの最後の要素を取得して削除します。
boolean	removeLastOccurrence(Object o) 両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最後に出現したものを削除します。
int	size() この両端キュー内の要素の数を返します。
Spliterator<E>	spliterator() この両端キュー内の要素に対する遅延バインディングおよびフェイルファスト Spliteratorを作成します。
Object[]	toArray() 両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。
<T> T[]	toArray(T[] a) 両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。

クラス java.util.AbstractCollectionから継承されたメソッド

addAll, containsAll, removeAll, retainAll, toString

クラス java.lang.Objectから継承されたメソッド

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

インタフェース java.util.Collectionから継承されたメソッド

addAll, containsAll, equals, hashCode, parallelStream, removeAll, removeIf, retainAll, stream

インタフェースjava.lang.Iterableから継承されたメソッド

forEach

コンストラクタの詳細

ArrayDeque

public ArrayDeque()

16個の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。

ArrayDeque

public ArrayDeque(int numElements)

指定された数の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。

パラメータ:

numElements - 両端キューの初期容量の範囲の下限

ArrayDeque

public ArrayDeque(Collection<? extends E> c)

指定されたコレクションのイテレータが返す順序で、その要素を格納する両端キューを作成します。コレクションのイテレータによって返される最初の要素が、最初の要素、つまり両端キューの先頭になります。

パラメータ:

c - 要素が両端キューに配置されるコレクション

例外:

NullPointerException - 指定されたコレクションがnullである場合

メソッドの詳細

addFirst

public void addFirst(E e)

指定された要素をこの両端キューの先頭に挿入します。

定義:

addFirst、インタフェース: Deque<E>

パラメータ:

e - 追加する要素

例外:

NullPointerException - 指定された要素がnullである場合

addLast

public void addLast(E e)

指定された要素をこの両端キューの末尾に挿入します。

このメソッドは、add(E)と同等です。

定義:

addLast、インタフェース: Deque<E>

パラメータ:

e - 追加する要素

例外:

NullPointerException - 指定された要素がnullである場合

offerFirst

public boolean offerFirst(E e)

指定された要素をこの両端キューの先頭に挿入します。

定義:

offerFirst、インタフェース: Deque<E>

パラメータ:

e - 追加する要素

戻り値:

true (Deque.offerFirst(E)で指定されているとおり)

例外:

NullPointerException - 指定された要素がnullである場合

offerLast

public boolean offerLast(E e)

指定された要素をこの両端キューの末尾に挿入します。

定義:

offerLast、インタフェース: Deque<E>

パラメータ:

e - 追加する要素

戻り値:

true (Deque.offerLast(E)で指定されているとおり)

例外:

NullPointerException - 指定された要素がnullである場合

removeFirst

public E removeFirst()

インタフェースからコピーされた説明: Deque

この両端キューの最初の要素を取得して削除します。このメソッドは、両端キューが空の場合に例外をスローする点のみがpollFirstメソッドと異なります。

定義:

removeFirst、インタフェース: Deque<E>

戻り値:

この両端キューの先頭

例外:

NoSuchElementException - この両端キューが空の場合

removeLast

public E removeLast()

インタフェースからコピーされた説明: Deque

この両端キューの最後の要素を取得して削除します。このメソッドは、両端キューが空の場合に例外をスローする点のみがpollLastメソッドと異なります。

定義:

removeLast、インタフェース: Deque<E>

戻り値:

この両端キューの末尾

例外:

NoSuchElementException - この両端キューが空の場合

pollFirst

public E pollFirst()

インタフェースからコピーされた説明: Deque

この両端キューの最初の要素を取得および削除します。両端キューが空の場合はnullを返します。

定義:

pollFirst、インタフェース: Deque<E>

戻り値:

この両端キューの先頭。この両端キューが空の場合はnull

pollLast

public E pollLast()

インタフェースからコピーされた説明: Deque

この両端キューの最後の要素を取得および削除します。両端キューが空の場合はnullを返します。

定義:

pollLast、インタフェース: Deque<E>

戻り値:

この両端キューの末尾。この両端キューが空の場合はnull

getFirst

public E getFirst()

インタフェースからコピーされた説明: Deque

この両端キューの最初の要素を取得しますが、削除はしません。このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekFirstメソッドと異なります。

定義:

getFirst、インタフェース: Deque<E>

戻り値:

この両端キューの先頭

例外:

NoSuchElementException - この両端キューが空の場合

getLast

public E getLast()

インタフェースからコピーされた説明: Deque

この両端キューの最後の要素を取得しますが、削除はしません。このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekLastメソッドと異なります。

定義:

getLast、インタフェース: Deque<E>

戻り値:

この両端キューの末尾

例外:

NoSuchElementException - この両端キューが空の場合

peekFirst

public E peekFirst()

インタフェースからコピーされた説明: Deque

この両端キューの最初の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。

定義:

peekFirst、インタフェース: Deque<E>

戻り値:

この両端キューの先頭。この両端キューが空の場合はnull

peekLast

public E peekLast()

インタフェースからコピーされた説明: Deque

この両端キューの最後の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。

定義:

peekLast、インタフェース: Deque<E>

戻り値:

この両端キューの末尾。この両端キューが空の場合はnull

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最初に出現したものを削除します。その要素が両端キューにない場合、変更はありません。つまり、o.equals(e)となる最初の要素eが存在する場合は、その要素を削除します。指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。

定義:

removeFirstOccurrence、インタフェース: Deque<E>

パラメータ:

o - この両端キューから削除される要素(その要素が存在する場合)

戻り値:

指定された要素がこの両端キューに含まれていた場合はtrue

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最後に出現したものを削除します。その要素が両端キューにない場合、変更はありません。つまり、o.equals(e)となる最後の要素eが存在する場合は、その要素を削除します。指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。

定義:

removeLastOccurrence、インタフェース: Deque<E>

パラメータ:

o - この両端キューから削除される要素(その要素が存在する場合)

戻り値:

指定された要素がこの両端キューに含まれていた場合はtrue

add

public boolean add(E e)

指定された要素をこの両端キューの末尾に挿入します。

このメソッドは、addLast(E)と同等です。

定義:

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

定義:

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

定義:

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

オーバーライド:

add、クラス: AbstractCollection<E>

パラメータ:

e - 追加する要素

戻り値:

true (Collection.add(E)で指定されているとおり)

例外:

NullPointerException - 指定された要素がnullである場合

offer

public boolean offer(E e)

指定された要素をこの両端キューの末尾に挿入します。

このメソッドは、offerLast(E)と同等です。

定義:

offer、インタフェース: Deque<E>

定義:

offer、インタフェース: Queue<E>

パラメータ:

e - 追加する要素

戻り値:

true (Queue.offer(E)で指定されているとおり)

例外:

NullPointerException - 指定された要素がnullである場合

remove

public E remove()

この両端キューが表すキューの先頭を取得して削除します。このメソッドは、両端キューが空の場合に例外をスローする点のみがpollメソッドと異なります。

このメソッドは、removeFirst()と同等です。

定義:

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

定義:

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

戻り値:

この両端キューで表されるキューの先頭

例外:

NoSuchElementException - この両端キューが空の場合

poll

public E poll()

この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得および削除します。両端キューが空の場合は、nullを返します。

このメソッドは、pollFirst()と同等です。

定義:

poll、インタフェース: Deque<E>

定義:

poll、インタフェース: Queue<E>

戻り値:

この両端キューで表されるキューの先頭。この両端キューが空の場合はnull

element

public E element()

この両端キューで表されるキューの先頭を取得しますが、削除しません。このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekメソッドと異なります。

このメソッドは、getFirst()と同等です。

定義:

element、インタフェース: Deque<E>

定義:

element、インタフェース: Queue<E>

戻り値:

この両端キューで表されるキューの先頭

例外:

NoSuchElementException - この両端キューが空の場合

peek

public E peek()

この両端キューによって表されるキューの先頭を取得しますが、削除しません。両端キューが空の場合はnullを返します。

このメソッドは、peekFirst()と同等です。

定義:

peek、インタフェース: Deque<E>

定義:

peek、インタフェース: Queue<E>

戻り値:

この両端キューで表されるキューの先頭。この両端キューが空の場合はnull

push

public void push(E e)

この両端キューで表されるスタックに要素を入れます。つまり、要素をこの両端キューの先頭に挿入します。

このメソッドは、addFirst(E)と同等です。

定義:

push、インタフェース: Deque<E>

パラメータ:

e - プッシュする要素

例外:

NullPointerException - 指定された要素がnullである場合

pop

public E pop()

この両端キューで表されるスタックに要素をポップします。つまり、この両端キューの最初の要素を削除して返します。

このメソッドは、removeFirst()と同等です。

定義:

pop、インタフェース: Deque<E>

戻り値:

この両端キューの先頭の要素(この両端キューによって表されるスタックの上部)

例外:

NoSuchElementException - この両端キューが空の場合

size

public int size()

この両端キュー内の要素の数を返します。

定義:

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

定義:

size、インタフェース: Deque<E>

定義:

size、クラス: AbstractCollection<E>

戻り値:

この両端キュー内の要素の数

isEmpty

public boolean isEmpty()

この両端キューに要素が含まれていない場合にtrueを返します。

定義:

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

オーバーライド:

isEmpty、クラス: AbstractCollection<E>

戻り値:

この両端キューに要素が含まれていない場合はtrue

iterator

public Iterator<E> iterator()

両端キューの要素のイテレータを返します。要素の順序は最初(先頭)から最後(末尾)になります。これは、要素がremove()の連続する呼出しによってキューから取り出される順序、またはpop()の連続する呼出しによってポップされる順序と同じです。

定義:

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

定義:

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

定義:

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

定義:

iterator、クラス: AbstractCollection<E>

戻り値:

両端キューの要素のイテレータ

descendingIterator

public Iterator<E> descendingIterator()

インタフェースからコピーされた説明: Deque

この両端キュー内の要素を逆順で反復処理するイテレータを返します。要素は最後(末尾)から最初(先頭)の順に返されます。

定義:

descendingIterator、インタフェース: Deque<E>

戻り値:

この両端キュー内の要素を逆順で反復処理するイテレータ

contains

public boolean contains(Object o)

指定された要素がこの両端キューに含まれている場合にtrueを返します。つまり、この両端キューに、o.equals(e)となる要素eが1つ以上含まれている場合にだけtrueを返します。

定義:

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

定義:

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

オーバーライド:

contains、クラス: AbstractCollection<E>

パラメータ:

o - この両端キューに含まれているかどうかを調べるオブジェクト

戻り値:

指定された要素がこの両端キューに含まれている場合はtrue

remove

public boolean remove(Object o)

指定された要素の単一のインスタンスを、この両端キューから削除します。その要素が両端キューにない場合、変更はありません。つまり、o.equals(e)となる最初の要素eが存在する場合は、その要素を削除します。指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。

このメソッドは、removeFirstOccurrence(Object)と同等です。

定義:

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

定義:

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

オーバーライド:

remove、クラス: AbstractCollection<E>

パラメータ:

o - この両端キューから削除される要素(その要素が存在する場合)

戻り値:

指定された要素がこの両端キューに含まれていた場合はtrue

clear

public void clear()

すべての要素を両端キューから削除します。この呼出しが戻ると、両端キューは空になります。

定義:

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

オーバーライド:

clear、クラス: AbstractCollection<E>

toArray

public Object[] toArray()

両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。

返される配列への参照を両端キューが維持しないという点で、この配列は安全です。(つまり、このメソッドは新しい配列を割り当てます。)このため、呼出し側は、返された配列を自由に変更できます。

このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。

定義:

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

オーバーライド:

toArray、クラス: AbstractCollection<E>

戻り値:

両端キューのすべての要素が格納されている配列

toArray

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

両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。指定された配列に両端キューが収まる場合は、その中に返されます。そうでない場合は、指定された配列の実行時の型と両端キューのサイズを持つ新しい配列が割り当てられます。

両端キューが指定された配列に収まり、その配列にさらに余裕がある場合(つまり、配列が両端キューより多くの要素を持つ場合)、その配列内で両端キューの終端よりあとの要素はnullに設定されます。

toArray()メソッドと同じように、このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。さらに、このメソッドでは、出力配列の実行時の型を正確に制御できるため、環境によっては割当ての手間を抑えることができます。

xが、文字列だけからなる両端キューであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられたStringの配列に両端キューをダンプできます。

  String[] y = x.toArray(new String[0]);

toArray(new Object[0])は、機能の点でtoArray()と同一です。

定義:

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

オーバーライド:

toArray、クラス: AbstractCollection<E>

型パラメータ:

T - コレクションを含む配列の実行時の型

パラメータ:

a - 配列が十分な大きさを持つ場合は、両端キューの要素が格納される配列。そうでない場合は、要素を格納するために同じ実行時の型の新しい配列が割り当てられる

戻り値:

両端キューのすべての要素が格納されている配列

例外:

ArrayStoreException - 指定された配列の実行時の型が、この両端キュー内のすべての要素の実行時の型のスーパー・タイプでない場合

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

clone

public ArrayDeque<E> clone()

この両端キューの複製を返します。

オーバーライド:

clone、クラス: Object

戻り値:

この両端キューのコピー

関連項目:

Cloneable

spliterator

public Spliterator<E> spliterator()

この両端キュー内の要素に対する遅延バインディングおよびフェイルファスト Spliteratorを作成します。

Spliteratorは、Spliterator.SIZED、Spliterator.SUBSIZED、Spliterator.ORDERED、およびSpliterator.NONNULLを報告します。オーバーライドする実装は、追加の特性値の報告をドキュメント化する必要があります。

定義:

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

定義:

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

戻り値:

この両端キュー内の要素に対するSpliterator

導入されたバージョン:

1.8