モジュール java.base

パッケージ java.util.concurrent

クラスLinkedBlockingDeque<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.LinkedBlockingDeque<E>

型パラメータ:

E - この両端キューに保持されている要素の型

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

Serializable, Iterable<E>, Collection<E>, BlockingDeque<E>, BlockingQueue<E>, Deque<E>, Queue<E>, SequencedCollection<E>

public class LinkedBlockingDeque<E> extends AbstractQueue<E> implements BlockingDeque<E>, Serializable

リンク・ノードに基づく、オプションで制限付きになるブロッキング両端キューです。

任意の容量制限のあるコンストラクタ引数が、過剰な展開を防ぐために機能します。 容量は、指定しない場合はInteger.MAX_VALUEと同じです。 リンク・ノードは、両端キューが容量を超えないかぎり挿入のたびに動的に作成されます。

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

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

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

導入されたバージョン:

1.6

関連項目:

• 直列化された形式

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

コンストラクタ

コンストラクタ	説明
LinkedBlockingDeque()	容量Integer.MAX_VALUEでLinkedBlockingDequeを作成します。
LinkedBlockingDeque(int capacity)	指定された固定容量でLinkedBlockingDequeを作成します。
LinkedBlockingDeque(Collection<? extends E> c)	指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加) LinkedBlockingDequeを容量Integer.MAX_VALUEで作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(E e)	容量制限に違反しないかぎり、指定された要素をこの両端キューの末尾に挿入します。
boolean	addAll(Collection<? extends E> c)	指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でこの両端キューの最後に追加します。
void	addFirst(E e)	容量制限に違反することなく指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。
void	addLast(E e)	容量制限に違反することなく指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。
void	clear()	すべての要素をこの両端キューから原子的に削除します。
boolean	contains(Object o)	指定された要素がこの両端キューに含まれている場合にtrueを返します。
Iterator<E>	descendingIterator()	この両端キュー内の要素を逆順で反復処理するイテレータを返します。
int	drainTo(Collection<? super E> c)	このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。
int	drainTo(Collection<? super E> c, int maxElements)	指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。
E	element()	この両端キューで表されるキューの先頭を取得しますが、削除しません。
void	forEach(Consumer<? super E> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。
E	getFirst()	この両端キューの最初の要素を取得しますが、削除はしません。
E	getLast()	この両端キューの最後の要素を取得しますが、削除はしません。
Iterator<E>	iterator()	この両端キュー内の要素を適切な順序で反復処理するイテレータを返します。
boolean	offer(E e)	指定された要素を、この両端キューで表されるキュー(つまり、この両端キューの末尾)に、容量制限に違反することなしにすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。
boolean	offer(E e, long timeout, TimeUnit unit)	指定された要素をこの両端キューで表されるキュー(つまり、この両端キューの末尾)に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。
boolean	offerFirst(E e)	容量制限に違反することなしに指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。
boolean	offerFirst(E e, long timeout, TimeUnit unit)	指定された要素をこの両端キューの先頭に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。
boolean	offerLast(E e)	容量制限に違反することなしに指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。
boolean	offerLast(E e, long timeout, TimeUnit unit)	指定された要素をこの両端キューの末尾に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。
E	peek()	この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得しますが、削除しません。両端キューが空の場合は、nullを返します。
E	peekFirst()	この両端キューの最初の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。
E	peekLast()	この両端キューの最後の要素を取得しますが、削除しません。両端キューが空の場合はnullを返します。
E	poll()	この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得および削除します。両端キューが空の場合は、nullを返します。
E	poll(long timeout, TimeUnit unit)	この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。
E	pollFirst()	この両端キューの最初の要素を取得および削除します。両端キューが空の場合はnullを返します。
E	pollFirst(long timeout, TimeUnit unit)	この両端キューの最初の要素を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。
E	pollLast()	この両端キューの最後の要素を取得および削除します。両端キューが空の場合はnullを返します。
E	pollLast(long timeout, TimeUnit unit)	この両端キューの最後の要素を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。
E	pop()	この両端キューで表されるスタックに要素をポップします。
void	push(E e)	容量制限に違反することなしに要素をこの両端キューで表されるスタック(つまり、この両端キューの先頭)にすぐにプッシュできる場合は、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。
void	put(E e)	指定された要素をこの両端キューで表されるキュー(つまり、この両端キューの末尾)に挿入します。必要に応じて、空きが生じるまで待機します。
void	putFirst(E e)	指定された要素をこの両端キューの先頭に挿入します。必要に応じて、空きが生じるまで待機します。
void	putLast(E e)	指定された要素をこの両端キューの末尾に挿入します。必要に応じて、空きが生じるまで待機します。
int	remainingCapacity()	理想的な状態(メモリーやリソースの制限がない状態)で、この両端キューがブロックせずに受け入れることができる追加要素の数を返します。
E	remove()	この両端キューが表すキューの先頭を取得して削除します。
boolean	remove(Object o)	指定された要素のうち最初に出現したものを、この両端キューから削除します。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
E	removeFirst()	この両端キューの最初の要素を取得して削除します。
boolean	removeFirstOccurrence(Object o)	指定された要素のうち最初に出現したものを、この両端キューから削除します。
boolean	removeIf(Predicate<? super E> filter)	指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。
E	removeLast()	この両端キューの最後の要素を取得して削除します。
boolean	removeLastOccurrence(Object o)	指定された要素のうち最後に出現したものを、この両端キューから削除します。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
int	size()	この両端キュー内の要素の数を返します。
Spliterator<E>	spliterator()	この両端キュー内の要素に対するSpliteratorを返します。
E	take()	この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。
E	takeFirst()	この両端キューの最初の要素を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。
E	takeLast()	この両端キューの最後の要素を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。
Object[]	toArray()	両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。
<T> T[]	toArray(T[] a)	両端キュー内のすべての要素を適切な順序で含む配列を返します。返される配列の実行時の型は、指定された配列の型になります。

クラスjava.util.AbstractCollectionで宣言されたメソッド

containsAll, isEmpty, toString

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

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

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

containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray

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

reversed

コンストラクタの詳細

LinkedBlockingDeque

public LinkedBlockingDeque()

容量Integer.MAX_VALUEでLinkedBlockingDequeを作成します。

LinkedBlockingDeque

public LinkedBlockingDeque(int capacity)

指定された固定容量でLinkedBlockingDequeを作成します。

パラメータ:

capacity - この両端キューの容量

例外:

IllegalArgumentException - capacityが1より小さい場合

LinkedBlockingDeque

public LinkedBlockingDeque(Collection<? extends E> c)

指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加) LinkedBlockingDequeを容量Integer.MAX_VALUEで作成します。

パラメータ:

c - 初期状態で含む要素のコレクション

例外:

NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合

メソッドの詳細

addFirst

public void addFirst(E e)

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

容量制限に違反することなく指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。 容量制限のある両端キューを使用する場合、通常はofferFirstメソッドを使用することをお薦めします。

定義:

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のaddFirst

パラメータ:

e - 追加する要素

例外:

IllegalStateException - この両端キューがいっぱいの場合

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

addLast

public void addLast(E e)

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

容量制限に違反することなく指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。 容量制限のある両端キューを使用する場合、通常はofferLastメソッドを使用することをお薦めします。

定義:

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のaddLast

パラメータ:

e - 追加する要素

例外:

IllegalStateException - この両端キューがいっぱいの場合

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

offerFirst

public boolean offerFirst(E e)

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

容量制限に違反することなしに指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。 容量制限のある両端キューを使用する場合、通常は、要素の挿入に失敗した場合に例外をスローするのみのaddFirstメソッドよりもこのメソッドを使用することをお薦めします。

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

要素がこの両端キューに追加された場合はtrue、それ以外の場合はfalse

例外:

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

offerLast

public boolean offerLast(E e)

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

容量制限に違反することなしに指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。 容量制限のある両端キューを使用する場合、通常は、要素の挿入に失敗した場合に例外をスローするのみのaddLastメソッドよりもこのメソッドを使用することをお薦めします。

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

要素がこの両端キューに追加された場合はtrue、それ以外の場合はfalse

例外:

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

putFirst

public void putFirst(E e) throws InterruptedException

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

指定された要素をこの両端キューの先頭に挿入します。必要に応じて、空きが生じるまで待機します。

定義:

putFirst、インタフェースBlockingDeque<E>

パラメータ:

e - 追加する要素

例外:

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

InterruptedException - 待機中に割込みが発生した場合

putLast

public void putLast(E e) throws InterruptedException

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

指定された要素をこの両端キューの末尾に挿入します。必要に応じて、空きが生じるまで待機します。

定義:

putLast、インタフェースBlockingDeque<E>

パラメータ:

e - 追加する要素

例外:

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

InterruptedException - 待機中に割込みが発生した場合

offerFirst

public boolean offerFirst(E e, long timeout, TimeUnit unit) throws InterruptedException

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

指定された要素をこの両端キューの先頭に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。

定義:

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

パラメータ:

e - 追加する要素

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

成功した場合はtrue、空きが生じる前に指定された待機時間が経過した場合はfalse

例外:

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

InterruptedException - 待機中に割込みが発生した場合

offerLast

public boolean offerLast(E e, long timeout, TimeUnit unit) throws InterruptedException

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

指定された要素をこの両端キューの末尾に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。

定義:

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

パラメータ:

e - 追加する要素

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

成功した場合はtrue、空きが生じる前に指定された待機時間が経過した場合はfalse

例外:

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

InterruptedException - 待機中に割込みが発生した場合

removeFirst

public E removeFirst()

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

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のremoveFirst

戻り値:

この両端キューの先頭

例外:

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

removeLast

public E removeLast()

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

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のremoveLast

戻り値:

この両端キューの末尾

例外:

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

pollFirst

public E pollFirst()

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

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

定義:

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

戻り値:

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

pollLast

public E pollLast()

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

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

定義:

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

戻り値:

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

takeFirst

public E takeFirst() throws InterruptedException

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

この両端キューの最初の要素を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。

定義:

takeFirst、インタフェースBlockingDeque<E>

戻り値:

この両端キューの先頭

例外:

InterruptedException - 待機中に割込みが発生した場合

takeLast

public E takeLast() throws InterruptedException

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

この両端キューの最後の要素を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。

定義:

takeLast、インタフェースBlockingDeque<E>

戻り値:

この両端キューの末尾

例外:

InterruptedException - 待機中に割込みが発生した場合

pollFirst

public E pollFirst(long timeout, TimeUnit unit) throws InterruptedException

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

この両端キューの最初の要素を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。

定義:

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

パラメータ:

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

この両端キューの先頭。空きが生じる前に指定された待機時間が経過した場合はnull

例外:

InterruptedException - 待機中に割込みが発生した場合

pollLast

public E pollLast(long timeout, TimeUnit unit) throws InterruptedException

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

この両端キューの最後の要素を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。

定義:

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

パラメータ:

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

この両端キューの末尾。空きが生じる前に指定された待機時間が経過した場合はnull

例外:

InterruptedException - 待機中に割込みが発生した場合

getFirst

public E getFirst()

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

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のgetFirst

戻り値:

この両端キューの先頭

例外:

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

getLast

public E getLast()

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

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

定義:

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

定義:

インタフェースSequencedCollection<E>内のgetLast

戻り値:

この両端キューの末尾

例外:

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)

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

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

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

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

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

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

add

public boolean add(E e)

容量制限に違反しないかぎり、指定された要素をこの両端キューの末尾に挿入します。 容量制限のある両端キューを使用する場合、通常はofferメソッドを使用することをお薦めします。

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

定義:

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

定義:

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

定義:

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

定義:

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

定義:

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

オーバーライド:

add、クラスAbstractQueue<E>

パラメータ:

e - 追加する要素

戻り値:

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

例外:

IllegalStateException - この両端キューがいっぱいの場合

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

offer

public boolean offer(E e)

指定された要素を、この両端キューで表されるキュー(つまり、この両端キューの末尾)に、容量制限に違反することなしにすぐに挿入できる場合には、そうします。成功した場合はtrueを返し、使用可能な空き領域がその時点で存在しない場合はfalseを返します。 容量制限のある両端キューを使用する場合、通常は、要素の挿入に失敗した場合に例外をスローするのみのBlockingDeque.add(E)メソッドよりも、このメソッドを使用することをお薦めします。

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

定義:

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

定義:

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

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

このキューに要素が追加された場合はtrue、それ以外の場合はfalse

例外:

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

put

public void put(E e) throws InterruptedException

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

指定された要素をこの両端キューで表されるキュー(つまり、この両端キューの末尾)に挿入します。必要に応じて、空きが生じるまで待機します。

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

定義:

put、インタフェースBlockingDeque<E>

定義:

put、インタフェースBlockingQueue<E>

パラメータ:

e - 追加する要素

例外:

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

InterruptedException - 待機中に割込みが発生した場合

offer

public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException

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

指定された要素をこの両端キューで表されるキュー(つまり、この両端キューの末尾)に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。

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

定義:

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

定義:

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

パラメータ:

e - 追加する要素

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

要素がこの両端キューに追加された場合はtrue、それ以外の場合はfalse

例外:

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

InterruptedException - 待機中に割込みが発生した場合

remove

public E remove()

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

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

定義:

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

定義:

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

定義:

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

オーバーライド:

remove、クラスAbstractQueue<E>

戻り値:

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

例外:

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

poll

public E poll()

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

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

定義:

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

定義:

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

定義:

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

戻り値:

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

take

public E take() throws InterruptedException

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

この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。

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

定義:

take、インタフェースBlockingDeque<E>

定義:

take、インタフェースBlockingQueue<E>

戻り値:

この両端キューの先頭

例外:

InterruptedException - 待機中に割込みが発生した場合

poll

public E poll(long timeout, TimeUnit unit) throws InterruptedException

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

この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。

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

定義:

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

定義:

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

パラメータ:

timeout - 処理を中止するまでの待機時間。単位はunit

unit - timeoutパラメータの解釈方法を決定するTimeUnit

戻り値:

この両端キューの先頭。空きが生じる前に指定された待機時間が経過した場合はnull

例外:

InterruptedException - 待機中に割込みが発生した場合

element

public E element()

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

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

定義:

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

定義:

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

定義:

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

オーバーライド:

element、クラスAbstractQueue<E>

戻り値:

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

例外:

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

peek

public E peek()

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

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

定義:

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

定義:

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

定義:

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

戻り値:

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

remainingCapacity

public int remainingCapacity()

理想的な状態(メモリーやリソースの制限がない状態)で、この両端キューがブロックせずに受け入れることができる追加要素の数を返します。 これは常に、この両端キューの初期容量から、この両端キューの現在のsizeを引いた値に等しくなります。

remainingCapacityを調べても要素の挿入試行が成功するかどうかがわかるとはかぎりません。これは別のスレッドが要素を挿入または削除しようとしている可能性があるためです。

定義:

remainingCapacity、インタフェースBlockingQueue<E>

戻り値:

残りの容量

drainTo

public int drainTo(Collection<? super E> c)

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

このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。 このオペレーションは、このキューを繰返しポーリングする場合よりも効率的な場合があります。 コレクションcに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。 キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。 また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

定義:

drainTo、インタフェースBlockingQueue<E>

パラメータ:

c - 要素の転送先のコレクション

戻り値:

転送された要素の数

例外:

UnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合

ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合

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

IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合

drainTo

public int drainTo(Collection<? super E> c, int maxElements)

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

指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。 コレクションcに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。 キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。 また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

定義:

drainTo、インタフェースBlockingQueue<E>

パラメータ:

c - 要素の転送先のコレクション

maxElements - 転送する要素の最大数

戻り値:

転送された要素の数

例外:

UnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合

ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合

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

IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合

push

public void push(E e)

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

容量制限に違反することなしに要素をこの両端キューで表されるスタック(つまり、この両端キューの先頭)にすぐにプッシュできる場合は、そうします。使用可能な空き領域がその時点で存在しない場合はIllegalStateExceptionをスローします。

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

定義:

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

定義:

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

パラメータ:

e - プッシュする要素

例外:

IllegalStateException - この両端キューがいっぱいの場合

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

pop

public E pop()

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

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

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

定義:

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

戻り値:

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

例外:

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

remove

public boolean remove(Object o)

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

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

定義:

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

定義:

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

定義:

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

定義:

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

オーバーライド:

remove、クラスAbstractCollection<E>

パラメータ:

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

戻り値:

この呼出しの結果、この両端キューが変更された場合はtrue

size

public int size()

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

定義:

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

定義:

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

定義:

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

戻り値:

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

contains

public boolean contains(Object o)

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

定義:

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

定義:

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

定義:

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

定義:

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

オーバーライド:

contains、クラスAbstractCollection<E>

パラメータ:

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

戻り値:

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

addAll

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

指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でこの両端キューの最後に追加します。 両端キューをそれ自体に対してaddAllしようとすると、IllegalArgumentExceptionが発生します。

定義:

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

定義:

インタフェースDeque<E>内のaddAll

オーバーライド:

addAll、クラスAbstractQueue<E>

パラメータ:

c - この両端キューに挿入される要素

戻り値:

この呼出しの結果、この両端キューが変更された場合はtrue

例外:

NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合

IllegalArgumentException - コレクションがこの両端キューである場合

IllegalStateException - この両端キューがいっぱいの場合

関連項目:

• add(Object)

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である場合

clear

public void clear()

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

定義:

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

オーバーライド:

clear、クラスAbstractQueue<E>

iterator

public Iterator<E> iterator()

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

返されるイテレータは弱一貫性を保持します。

定義:

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

定義:

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

定義:

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

定義:

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

定義:

iterator、クラスAbstractCollection<E>

戻り値:

この両端キュー内の要素を適切な順序で繰返し処理するイテレータ

descendingIterator

public Iterator<E> descendingIterator()

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

返されるイテレータは弱一貫性を保持します。

定義:

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

戻り値:

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

spliterator

public Spliterator<E> spliterator()

この両端キュー内の要素に対するSpliteratorを返します。

返されるスプリッテレータは弱一貫性を保持します。

Spliteratorは、Spliterator.CONCURRENT、Spliterator.ORDEREDおよびSpliterator.NONNULLを報告します。

定義:

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

定義:

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

実装上のノート:

Spliteratorは、制限付きの並列処理を許可するためにtrySplitを実装します。

戻り値:

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

導入されたバージョン:

1.8

forEach

public void forEach(Consumer<? super E> action)

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

Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。

このメソッドの動作は、オーバーライドするクラスが同時変更ポリシーを指定していないかぎり、要素の基礎となるソースを変更する副作用をアクションが実行する場合には指定されません。

定義:

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

パラメータ:

action - 各要素に対して実行されるアクション

例外:

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

removeIf

public boolean removeIf(Predicate<? super E> filter)

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

指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。 反復中に、または述語によってスローされたエラーまたは実行時例外は、呼出し側に中継されます。

定義:

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

パラメータ:

filter - 削除される要素に対してtrueを返す述語

戻り値:

要素が削除された場合はtrue

例外:

NullPointerException - 指定されたフィルタがnullである場合

removeAll

public boolean removeAll(Collection<?> c)

次のクラスからコピーされた説明: AbstractCollection

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

定義:

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

オーバーライド:

removeAll、クラスAbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

関連項目:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

次のクラスからコピーされた説明: AbstractCollection

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

定義:

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

オーバーライド:

retainAll、クラスAbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

関連項目:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)