Package org.apache.bookkeeper.common.collections

Class BatchedArrayBlockingQueue<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<T>

org.apache.bookkeeper.common.collections.BatchedArrayBlockingQueue<T>

All Implemented Interfaces:

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

public class BatchedArrayBlockingQueue<T>
extends AbstractQueue<T>
implements BlockingQueue<T>, BatchedBlockingQueue<T>

This implements a BlockingQueue backed by an array with fixed capacity.

This queue only allows 1 consumer thread to dequeue items and multiple producer threads.

Constructor Summary

Constructors

Constructor	Description
BatchedArrayBlockingQueue(int capacity)

Method Summary

Modifier and Type	Method	Description
void	clear()
int	drainTo(Collection<? super T> c)
int	drainTo(Collection<? super T> c, int maxElements)
Iterator<T>	iterator()
boolean	offer(T e)
boolean	offer(T e, long timeout, TimeUnit unit)
T	peek()
T	poll()
T	poll(long timeout, TimeUnit unit)
int	pollAll(T[] array, long timeout, TimeUnit unit)	Removes multiple items from the queue.
void	put(T e)
int	putAll(List<T> c)
void	putAll(T[] a, int offset, int len)
int	remainingCapacity()
int	size()
T	take()
int	takeAll(T[] array)	Drain the queue into an array.

Methods inherited from class java.util.AbstractQueue

add, addAll, 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, 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

BatchedArrayBlockingQueue

public BatchedArrayBlockingQueue(int capacity)

Method Details

poll

public T poll()

Specified by:

poll in interface Queue<T>

peek

public T peek()

Specified by:

peek in interface Queue<T>

offer

public boolean offer(T e)

Specified by:

offer in interface BlockingQueue<T>

Specified by:

offer in interface Queue<T>

put

public void put(T e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<T>

Throws:

InterruptedException

putAll

public int putAll(List<T> c)
           throws InterruptedException

Throws:

InterruptedException

putAll

public void putAll(T[] a,
 int offset,
 int len)
            throws InterruptedException

Specified by:

putAll in interface BatchedBlockingQueue<T>

Throws:

InterruptedException

offer

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

Specified by:

offer in interface BlockingQueue<T>

Throws:

InterruptedException

take

public T take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<T>

Throws:

InterruptedException

poll

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

Specified by:

poll in interface BlockingQueue<T>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<T>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<T>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<T>

takeAll

public int takeAll(T[] array)
            throws InterruptedException

Description copied from interface: BatchedBlockingQueue

Drain the queue into an array. Wait if there are no items in the queue.

Specified by:

takeAll in interface BatchedBlockingQueue<T>

Returns:

Throws:

InterruptedException

pollAll

public int pollAll(T[] array,
 long timeout,
 TimeUnit unit)
            throws InterruptedException

Description copied from interface: BatchedBlockingQueue

Removes multiple items from the queue. The method returns when either: 1. At least one item is available 2. The timeout expires

Specified by:

pollAll in interface BatchedBlockingQueue<T>

Returns:

Throws:

InterruptedException

clear

public void clear()

Specified by:

clear in interface Collection<T>

Overrides:

clear in class AbstractQueue<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in class AbstractCollection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in class AbstractCollection<T>