Class BlockingArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.eclipse.jetty.util.BlockingArrayQueue<E>

Type Parameters:

E - The element type

All Implemented Interfaces:

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

public class BlockingArrayQueue<E>
extends AbstractList<E>
implements BlockingQueue<E>

A BlockingQueue backed by a circular array capable of growing.

This queue is uses a variant of the two lock queue algorithm to provide an efficient queue or list backed by a growable circular array.

Unlike ArrayBlockingQueue, this class is able to grow and provides a blocking put(Object) call.

The queue has both a capacity (the size of the array currently allocated) and a max capacity (the maximum size that may be allocated), which defaults to Integer.MAX_VALUE.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CAPACITY	Default initial capacity, 128.
static final int	DEFAULT_GROWTH	Deprecated, for removal: This API element is subject to removal in a future version. the growth strategy has changed and doesn't use this constant anymore.

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
BlockingArrayQueue()	Creates an unbounded instance with default initial capacity.
BlockingArrayQueue(int maxCapacity)	Creates an instance that does not grow.
BlockingArrayQueue(int capacity, int growBy)	Deprecated, for removal: This API element is subject to removal in a future version. the growth factor isn't used anymore
BlockingArrayQueue(int capacity, int growBy, int maxCapacity)	Deprecated, for removal: This API element is subject to removal in a future version. the growth factor isn't used anymore

Method Summary

Modifier and Type	Method	Description
void	add(int index, E e)
boolean	add(E e)
void	clear()
int	drainTo(Collection<? super E> c)
int	drainTo(Collection<? super E> c, int maxElements)
E	element()
E	get(int index)
int	getCapacity()	Get the current capacity of this queue.
int	getMaxCapacity()	Get the max capacity of this queue.
Iterator<E>	iterator()
ListIterator<E>	listIterator(int index)
static <E> BlockingArrayQueue<E>	newInstance(int capacity, int maxCapacity)	Creates a BlockingArrayQueue with given initial and max capacities.
boolean	offer(E e)
boolean	offer(E o, long timeout, TimeUnit unit)
E	peek()
E	poll()
E	poll(long time, TimeUnit unit)
void	put(E e)
int	remainingCapacity()
E	remove()
E	remove(int index)
boolean	remove(Object o)
E	set(int index, E e)
int	size()
E	take()

Methods inherited from class AbstractList

addAll, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class AbstractCollection

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

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface BlockingQueue

contains

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, isEmpty, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, toArray, toArray

Field Details

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

Default initial capacity, 128.

See Also:

• Constant Field Values

DEFAULT_GROWTH

@Deprecated(since="12.1.2",
            forRemoval=true)
public static final int DEFAULT_GROWTH

Deprecated, for removal: This API element is subject to removal in a future version.

the growth strategy has changed and doesn't use this constant anymore.

Old default growth factor, 64.

See Also:

• Constant Field Values

Constructor Details

BlockingArrayQueue

public BlockingArrayQueue()

Creates an unbounded instance with default initial capacity.

See Also:

• DEFAULT_CAPACITY

BlockingArrayQueue

public BlockingArrayQueue(int maxCapacity)

Creates an instance that does not grow. The capacity of the queue is fixed and equal to the given parameter.

Parameters:

maxCapacity - the maximum capacity

BlockingArrayQueue

@Deprecated(since="12.1.2",
            forRemoval=true)
public BlockingArrayQueue(int capacity,
 int growBy)

Deprecated, for removal: This API element is subject to removal in a future version.

the growth factor isn't used anymore

Creates an unbounded instance.

Parameters:

capacity - the initial capacity

growBy - the growth factor

BlockingArrayQueue

@Deprecated(since="12.1.2",
            forRemoval=true)
public BlockingArrayQueue(int capacity,
 int growBy,
 int maxCapacity)

Deprecated, for removal: This API element is subject to removal in a future version.

the growth factor isn't used anymore

Creates an instance with given initial and max capacities.

Parameters:

capacity - the initial capacity

growBy - the growth factor

maxCapacity - the maximum capacity

Method Details

newInstance

public static <E> BlockingArrayQueue<E> newInstance(int capacity,
 int maxCapacity)

Creates a BlockingArrayQueue with given initial and max capacities.

Parameters:

capacity - the initial capacity

maxCapacity - the maximum capacity

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<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 interface List<E>

Overrides:

iterator in class AbstractList<E>

poll

public E poll()

Specified by:

poll in interface Queue<E>

poll

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

Specified by:

poll in interface BlockingQueue<E>

Throws:

InterruptedException

peek

public E peek()

Specified by:

peek in interface Queue<E>

remove

public E remove()

Specified by:

remove in interface Queue<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface BlockingQueue<E>

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractCollection<E>

element

public E element()

Specified by:

element in interface Queue<E>

offer

public boolean offer(E e)

Specified by:

offer in interface BlockingQueue<E>

Specified by:

offer in interface Queue<E>

offer

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

Specified by:

offer in interface BlockingQueue<E>

Throws:

InterruptedException

add

public boolean add(E e)

Specified by:

add in interface BlockingQueue<E>

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class AbstractList<E>

add

public void add(int index,
 E e)

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

put

public void put(E e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<E>

Throws:

InterruptedException

take

public E take()
       throws InterruptedException

Specified by:

take 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>

get

public E get(int index)

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

set

public E set(int index,
 E e)

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

getCapacity

public int getCapacity()

Get the current capacity of this queue.

Returns:

the current capacity of this queue

getMaxCapacity

public int getMaxCapacity()

Get the max capacity of this queue.

Returns:

the max capacity of this queue