Package 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:

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

public class ArrayBlockingQueueWithShutdown<E>
extends AbstractQueue<E>
implements 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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArrayBlockingQueueWithShutdown.TryPutResult
static final class	ArrayBlockingQueueWithShutdown.TryTakeResult<E>
static enum	ArrayBlockingQueueWithShutdown.TryTakeResultCode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	drainTo(Collection<? super E> c)
int	drainTo(Collection<? super E> c, int maxElements)
boolean	isShutdown()	Returns true if the queue is currently shut down.
Iterator<E>	iterator()
boolean	offer(E e)
boolean	offer(E e, long timeout, TimeUnit unit)
boolean	offerAndShutdown(E e)
E	peek()
E	poll()
E	poll(long timeout, TimeUnit unit)
void	put(E e)	Inserts the specified element into this queue, waiting if necessary for space to become available.
void	putAll(Collection<? extends E> elements)
boolean	putIfNotShutdown(E e)	Put if the queue has not been shutdown yet.
int	remainingCapacity()
void	shutdown()	Shutdown the Queue.
int	size()
boolean	start()	Start the queue.
E	take()
ArrayBlockingQueueWithShutdown.TryPutResult	tryPut(E e)
ArrayBlockingQueueWithShutdown.TryTakeResult<E>	tryTake()

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.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, remove

Constructor Details

ArrayBlockingQueueWithShutdown

public ArrayBlockingQueueWithShutdown(int capacity)

ArrayBlockingQueueWithShutdown

public ArrayBlockingQueueWithShutdown(int capacity,
 boolean fair)

Method Details

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 boolean start()

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

Returns:

true if the queues was shutdown before, false if not.

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 Queue<E>

peek

public E peek()

Specified by:

peek in interface Queue<E>

offer

public boolean offer(E e)

Specified by:

offer in interface BlockingQueue<E>

Specified by:

offer in interface Queue<E>

offerAndShutdown

public boolean offerAndShutdown(E e)

put

public void put(E e)
         throws InterruptedException

Inserts the specified element into this queue, waiting if necessary for space to become available.

This may throw an InterruptedException in two cases

1. If the queue was shut down.
2. If the thread was was interrupted.

So you have to check which is the case, e.g. by calling isShutdown().

Specified by:

put in interface BlockingQueue<E>

Parameters:

e - the element to add.

Throws:

InterruptedException - if interrupted while waiting or if the queue was shut down.

putIfNotShutdown

public boolean putIfNotShutdown(E e)
                         throws InterruptedException

Put if the queue has not been shutdown yet.

Parameters:

e - the element to put into the queue.

Returns:

true if the element has been put into the queue, false if the queue was shutdown.

Throws:

InterruptedException - if the calling thread was interrupted.

Since:

4.4

putAll

public void putAll(Collection<? extends E> elements)
            throws InterruptedException

Throws:

InterruptedException

tryPut

public ArrayBlockingQueueWithShutdown.TryPutResult tryPut(E e)

offer

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

Specified by:

offer in interface BlockingQueue<E>

Throws:

InterruptedException

take

public E take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<E>

Throws:

InterruptedException

tryTake

public ArrayBlockingQueueWithShutdown.TryTakeResult<E> tryTake()

poll

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

Specified by:

poll in interface BlockingQueue<E>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<E>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<E>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in class AbstractCollection<E>