Package gov.usgs.earthquake.util

Class RoundRobinBlockingQueue<T>

java.lang.Object

gov.usgs.earthquake.util.RoundRobinQueue<T>

gov.usgs.earthquake.util.RoundRobinBlockingQueue<T>

Type Parameters:

T - queue item type.

All Implemented Interfaces:

Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>

Direct Known Subclasses:

ListenerNotificationQueue, NotificationEventBlockingQueue

public class RoundRobinBlockingQueue<T>
extends RoundRobinQueue<T>
implements BlockingQueue<T>

Round Robin Blocking Queue. put(Object) and take() are recommended, as other methods internally call these methods.

Constructor Summary

Constructors

Constructor	Description
RoundRobinBlockingQueue()	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	add(T e)	Add an item to the queue.
boolean	contains(Object e)	Check if queue contains an item.
int	drainTo(Collection<? super T> c)	Empty queue into a collection.
int	drainTo(Collection<? super T> c, int max)	Empty queue into a collection, stopping after max elements.
boolean	offer(T e)	Offer an item to the queue.
boolean	offer(T e, long timeout, TimeUnit unit)	Offer an item to the queue.
T	poll(long timeout, TimeUnit unit)	Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
void	put(T e)	Put an item in the queue.
int	remainingCapacity()	Unbounded queues return Integer.MAX_VALUE.
boolean	remove(Object e)	Remove an object from the queue.
T	take()	Remove an object from the queue.

Methods inherited from class gov.usgs.earthquake.util.RoundRobinQueue

addAll, clear, containsAll, element, getQueueId, isEmpty, iterator, peek, poll, remove, removeAll, retainAll, size, toArray, toArray, toList

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, peek, poll, remove

Constructor Details

RoundRobinBlockingQueue

public RoundRobinBlockingQueue()

Constructor

Method Details

add

public boolean add(T e)

Add an item to the queue.

Specified by:

add in interface BlockingQueue<T>

Specified by:

add in interface Collection<T>

Specified by:

add in interface Queue<T>

Overrides:

add in class RoundRobinQueue<T>

Parameters:

e - item to add

Returns:

true if added.

contains

public boolean contains(Object e)

Check if queue contains an item.

Specified by:

contains in interface BlockingQueue<T>

Specified by:

contains in interface Collection<T>

Overrides:

contains in class RoundRobinQueue<T>

offer

public boolean offer(T e)

Offer an item to the queue. Calls add(Object), but returns false if any exceptions thrown.

Specified by:

offer in interface BlockingQueue<T>

Specified by:

offer in interface Queue<T>

Overrides:

offer in class RoundRobinQueue<T>

Parameters:

e - item to add

Returns:

true if added, false otherwise.

offer

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

Offer an item to the queue. Same as offer(Object), this is an unbounded queue.

Specified by:

offer in interface BlockingQueue<T>

Throws:

InterruptedException

poll

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

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

Specified by:

poll in interface BlockingQueue<T>

Throws:

InterruptedException

put

public void put(T e)
         throws InterruptedException

Put an item in the queue.

Specified by:

put in interface BlockingQueue<T>

Throws:

InterruptedException - if interrupted while acquiring lock.

remainingCapacity

public int remainingCapacity()

Unbounded queues return Integer.MAX_VALUE.

Specified by:

remainingCapacity in interface BlockingQueue<T>

Returns:

Integer.MAX_VALUE;

remove

public boolean remove(Object e)

Remove an object from the queue.

Specified by:

remove in interface BlockingQueue<T>

Specified by:

remove in interface Collection<T>

Overrides:

remove in class RoundRobinQueue<T>

take

public T take()
       throws InterruptedException

Remove an object from the queue.

Specified by:

take in interface BlockingQueue<T>

Throws:

InterruptedException

drainTo

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

Empty queue into a collection.

Specified by:

drainTo in interface BlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> c,
 int max)

Empty queue into a collection, stopping after max elements.

Specified by:

drainTo in interface BlockingQueue<T>