java.util.concurrent
インタフェース BlockingDeque<E>

型パラメータ:

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

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

BlockingQueue<E>, Collection<E>, Deque<E>, Iterable<E>, Queue<E>

既知の実装クラスの一覧:

LinkedBlockingDeque

public interface BlockingDeque<E>
extends BlockingQueue<E>, Deque<E>

要素の取得時に両端キューが空でなくなるまで待機したり、要素の格納時に両端キュー内に空きが生じるまで待機するブロック操作を追加でサポートしたりする Deque です。

BlockingDeque メソッドには 4 つの形式があり、すぐには達成できなくても将来のある時点で達成できる可能性がある操作を異なる方法で処理します。1 つめは例外をスローし、2 つめは特殊な値 (操作に応じて null と false のいずれか) を返し、3 つめは操作が正常に完了するまで現在のスレッドを無期限にブロックし、4 つめは処理を中止するまで指定された制限時間内のみブロックします。これらのメソッドについて、次の表にまとめます。

最初の要素 (先頭)
	例外をスローする	特殊な値	ブロック	タイムアウト
挿入	addFirst(e)	offerFirst(e)	putFirst(e)	offerFirst(e, time, unit)
削除	removeFirst()	pollFirst()	takeFirst()	pollFirst(time, unit)
検査	getFirst()	peekFirst()	適用外	適用外
最後の要素 (末尾)
	例外をスローする	特殊な値	ブロック	タイムアウト
挿入	addLast(e)	offerLast(e)	putLast(e)	offerLast(e, time, unit)
削除	removeLast()	pollLast()	takeLast()	pollLast(time, unit)
検査	getLast()	peekLast()	適用外	適用外

BlockingQueue と同様、BlockingDeque はスレッドセーフであり、null 要素を許容しません。また、容量が制限されていることも制限されていないこともあります。

BlockingDeque 実装は、FIFO の BlockingQueue として直接使用されることがあります。BlockingQueue インタフェースから継承されたメソッドは、次の表に示すように BlockingDeque メソッドとまったくの等価です。

BlockingQueue メソッド	同等の BlockingDeque メソッド
挿入
add(e)	addLast(e)
offer(e)	offerLast(e)
put(e)	putLast(e)
offer(e, time, unit)	offerLast(e, time, unit)
削除
remove()	removeFirst()
poll()	pollFirst()
take()	takeFirst()
poll(time, unit)	pollFirst(time, unit)
検査
element()	getFirst()
peek()	peekFirst()

メモリー整合性効果:ほかの並行処理コレクションと同様、オブジェクトを BlockingDeque に配置する前のスレッド内のアクションは、別のスレッドでのその要素へのアクセスまたは BlockingDeque からの削除に続くアクションよりも「前に発生」します。

このインタフェースは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.6

メソッドの概要

boolean	add(E e) 指定された要素を、この両端キューで表されるキュー (つまり、この両端キューの末尾) に、容量制限に違反することなしにすぐに挿入できる場合には、そうします。
void	addFirst(E e) 容量制限に違反することなく指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。
void	addLast(E e) 容量制限に違反することなしに指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。
boolean	contains(Object o) 指定された要素がこの両端キューに含まれている場合に true を返します。
E	element() この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得しますが、削除しません。
Iterator<E>	iterator() この両端キュー内の要素を適切な順序で繰り返し処理する反復子を返します。
boolean	offer(E e) 指定された要素を、この両端キューで表されるキュー (つまり、この両端キューの末尾) に、容量制限に違反することなしにすぐに挿入できる場合には、そうします。
boolean	offer(E e, long timeout, TimeUnit unit) 指定された要素をこの両端キューで表されるキュー (つまり、この両端キューの末尾) に挿入します。
boolean	offerFirst(E e) 容量制限に違反することなしに指定された要素をこの両端キューの先頭にすぐに挿入できる場合には、そうします。
boolean	offerFirst(E e, long timeout, TimeUnit unit) 指定された要素をこの両端キューの先頭に挿入します。
boolean	offerLast(E e) 容量制限に違反することなしに指定された要素をこの両端キューの末尾にすぐに挿入できる場合には、そうします。
boolean	offerLast(E e, long timeout, TimeUnit unit) 指定された要素をこの両端キューの末尾に挿入します。
E	peek() この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得しますが、削除しません。
E	poll() この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得して削除します。
E	poll(long timeout, TimeUnit unit) この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得して削除します。
E	pollFirst(long timeout, TimeUnit unit) この両端キューの最初の要素を取得して削除します。
E	pollLast(long timeout, TimeUnit unit) この両端キューの最後の要素を取得して削除します。
void	push(E e) この両端キューで表されるスタックに要素を入れます。
void	put(E e) 指定された要素をこの両端キューで表されるキュー (つまり、この両端キューの末尾) に挿入します。
void	putFirst(E e) 指定された要素をこの両端キューの先頭に挿入します。
void	putLast(E e) 指定された要素をこの両端キューの末尾に挿入します。
E	remove() この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得して削除します。
boolean	remove(Object o) 指定された要素のうち最初に出現したものを、この両端キューから削除します。
boolean	removeFirstOccurrence(Object o) 指定された要素のうち最初に出現したものを、この両端キューから削除します。
boolean	removeLastOccurrence(Object o) 指定された要素のうち最後に出現したものを、この両端キューから削除します。
int	size() この両端キュー内の要素の数を返します。
E	take() この両端キューによって表されるキューの先頭 (つまり、この両端キューの最初の要素) を取得して削除します。
E	takeFirst() この両端キューの最初の要素を取得して削除します。
E	takeLast() この両端キューの最後の要素を取得して削除します。

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

drainTo, drainTo, remainingCapacity

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

descendingIterator, getFirst, getLast, peekFirst, peekLast, pollFirst, pollLast, pop, removeFirst, removeLast

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

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

メソッドの詳細

addFirst

void addFirst(E e)

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

定義:

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

パラメータ:

e - 追加する要素

例外:

IllegalStateException - 容量制限が原因でこの時点で要素を追加できない場合

ClassCastException - 指定された要素のクラスが原因で、この両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

addLast

void addLast(E e)

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

定義:

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

パラメータ:

e - 追加する要素

例外:

IllegalStateException - 容量制限が原因でこの時点で要素を追加できない場合

ClassCastException - 指定された要素のクラスが原因で、この両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offerFirst

boolean offerFirst(E e)

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

要素がこの両端キューに追加された場合は true、そうでない場合は false

例外:

ClassCastException - 指定された要素のクラスが原因で、この両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offerLast

boolean offerLast(E e)

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

要素がこの両端キューに追加された場合は true、そうでない場合は false

例外:

ClassCastException - 指定された要素のクラスが原因で、この両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

putFirst

void putFirst(E e)
              throws InterruptedException

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

パラメータ:

e - 追加する要素

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

putLast

void putLast(E e)
             throws InterruptedException

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

パラメータ:

e - 追加する要素

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offerFirst

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

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

パラメータ:

e - 追加する要素

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

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

戻り値:

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

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offerLast

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

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

パラメータ:

e - 追加する要素

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

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

戻り値:

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

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

takeFirst

E takeFirst()
            throws InterruptedException

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

戻り値:

この両端キューの先頭

例外:

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

takeLast

E takeLast()
           throws InterruptedException

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

戻り値:

この両端キューの末尾

例外:

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

pollFirst

E pollFirst(long timeout,
            TimeUnit unit)
            throws InterruptedException

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

パラメータ:

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

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

戻り値:

この両端キューの先頭、要素が利用可能になる前に指定された待機時間が経過した場合は null

例外:

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

pollLast

E pollLast(long timeout,
           TimeUnit unit)
           throws InterruptedException

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

パラメータ:

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

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

戻り値:

この両端キューの末尾、要素が利用可能になる前に指定された待機時間が経過した場合は null

例外:

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

removeFirstOccurrence

boolean removeFirstOccurrence(Object o)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素のクラスが、この両端キューと互換でない場合 (省略可能)

NullPointerException - 指定された要素が null である場合 (省略可能)

removeLastOccurrence

boolean removeLastOccurrence(Object o)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素のクラスが、この両端キューと互換でない場合 (省略可能)

NullPointerException - 指定された要素が null である場合 (省略可能)

add

boolean add(E e)

指定された要素を、この両端キューで表されるキュー (つまり、この両端キューの末尾) に、容量制限に違反することなしにすぐに挿入できる場合には、そうします。成功した場合は true を返し、使用可能な空き領域がその時点で存在しない場合は IllegalStateException をスローします。容量制限のある両端キューを使用する場合、通常は offer を使用することをお勧めします。

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

定義:

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

定義:

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

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

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

例外:

IllegalStateException - 容量制限が原因でこの時点で要素を追加できない場合

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offer

boolean offer(E e)

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

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

定義:

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

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

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

例外:

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

put

void put(E e)
         throws InterruptedException

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

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

定義:

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

パラメータ:

e - 追加する要素

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

offer

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

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

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

定義:

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

パラメータ:

e - 追加する要素

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

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

戻り値:

要素がこの両端キューに追加された場合は true、そうでない場合は false

例外:

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

ClassCastException - 指定された要素のクラスが原因で、両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合

remove

E remove()

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

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

定義:

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

定義:

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

戻り値:

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

例外:

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

poll

E poll()

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

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

定義:

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

定義:

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

戻り値:

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

take

E take()
       throws InterruptedException

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

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

定義:

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

戻り値:

この両端キューの先頭

例外:

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

poll

E poll(long timeout,
       TimeUnit unit)
       throws InterruptedException

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

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

定義:

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

パラメータ:

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

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

戻り値:

この両端キューの先頭、要素が利用可能になる前に指定された待機時間が経過した場合は null

例外:

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

element

E element()

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

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

定義:

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

定義:

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

戻り値:

この両端キューの先頭

例外:

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

peek

E peek()

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

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

定義:

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

定義:

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

戻り値:

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

remove

boolean remove(Object o)

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

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

定義:

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

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素のクラスが、この両端キューと互換でない場合 (省略可能)

NullPointerException - 指定された要素が null である場合 (省略可能)

contains

boolean contains(Object o)

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

定義:

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

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素のクラスが、この両端キューと互換でない場合 (省略可能)

NullPointerException - 指定された要素が null である場合 (省略可能)

size

int size()

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

定義:

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

定義:

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

戻り値:

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

iterator

Iterator<E> iterator()

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

定義:

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

定義:

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

定義:

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

戻り値:

両端キュー内の要素を適切な順序で繰り返し処理する反復子

push

void push(E e)

この両端キューで表されるスタックに要素を入れます。つまり、容量制限に違反しないかぎり、要素をこの両端キューの先頭に挿入します。

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

定義:

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

パラメータ:

e - プッシュする要素

例外:

IllegalStateException - 容量制限が原因でこの時点で要素を追加できない場合

ClassCastException - 指定された要素のクラスが原因で、この両端キューに要素を追加できない場合

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

IllegalArgumentException - 指定された要素のあるプロパティーが原因で、この両端キューに要素を追加できない場合