org.jivesoftware.smack.util

Class ArrayBlockingQueueWithShutdown<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jivesoftware.smack.util.ArrayBlockingQueueWithShutdown<E>

Type Parameters:

E - the type of elements held in this collection

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.concurrent.BlockingQueue<E>, java.util.Queue<E>

public class ArrayBlockingQueueWithShutdown<E>
extends java.util.AbstractQueue<E>
implements java.util.concurrent.BlockingQueue<E>

Like ArrayBlockingQueue but with additional shutdown() and start() methods. Will throw InterruptedException if Queue has been shutdown on take() and poll(long, TimeUnit).

Based on ArrayBlockingQueue of OpenJDK by Doug Lea (who released ArrayBlockingQueue as public domain).

Constructor Summary

Constructors

Constructor and Description
ArrayBlockingQueueWithShutdown(int capacity)
ArrayBlockingQueueWithShutdown(int capacity, boolean fair)

Method Summary

Modifier and Type	Method and Description
int	drainTo(java.util.Collection<? super E> c)
int	drainTo(java.util.Collection<? super E> c, int maxElements)
boolean	isShutdown() Returns true if the queue is currently shut down.
java.util.Iterator<E>	iterator()
boolean	offer(E e)
boolean	offer(E e, long timeout, java.util.concurrent.TimeUnit unit)
E	peek()
E	poll()
E	poll(long timeout, java.util.concurrent.TimeUnit unit)
void	put(E e)
int	remainingCapacity()
void	shutdown() Shutdown the Queue.
int	size()
void	start() Start the queue.
E	take()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, remove

Methods inherited from interface java.util.Queue

element, remove

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ArrayBlockingQueueWithShutdown

public ArrayBlockingQueueWithShutdown(int capacity)

ArrayBlockingQueueWithShutdown

public ArrayBlockingQueueWithShutdown(int capacity,
                                      boolean fair)

Method Detail

shutdown

public void shutdown()

Shutdown the Queue. Will method currently waiting for a not full/empty condition will unblock (and usually throw a InterruptedException).

start

public void start()

Start the queue. Newly created instances will be started automatically, thus this only needs to be called after shutdown().

isShutdown

public boolean isShutdown()

Returns true if the queue is currently shut down.

Returns:

true if the queue is shut down.

poll

public E poll()

Specified by:

poll in interface java.util.Queue<E>

peek

public E peek()

Specified by:

peek in interface java.util.Queue<E>

offer

public boolean offer(E e)

Specified by:

offer in interface java.util.concurrent.BlockingQueue<E>

Specified by:

offer in interface java.util.Queue<E>

put

public void put(E e)
         throws java.lang.InterruptedException

Specified by:

put in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

offer

public boolean offer(E e,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Specified by:

offer in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

take

public E take()
       throws java.lang.InterruptedException

Specified by:

take in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

poll

public E poll(long timeout,
              java.util.concurrent.TimeUnit unit)
       throws java.lang.InterruptedException

Specified by:

poll in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface java.util.concurrent.BlockingQueue<E>

drainTo

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

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<E>

drainTo

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

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in class java.util.AbstractCollection<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in class java.util.AbstractCollection<E>