Package org.elasticsearch.common.util.concurrent

Class SizeBlockingQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.elasticsearch.common.util.concurrent.SizeBlockingQueue<E>

All Implemented Interfaces:

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

public class SizeBlockingQueue<E>
extends AbstractQueue<E>
implements BlockingQueue<E>

A size based queue wrapping another blocking queue to provide (somewhat relaxed) capacity checks. Mainly makes sense to use with blocking queues that are unbounded to provide the ability to do capacity verification.

Constructor Summary

Constructors

Constructor	Description
SizeBlockingQueue(BlockingQueue<E> queue, int capacity)

Method Summary

Modifier and Type	Method	Description
int	capacity()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
int	drainTo(Collection<? super E> c)
int	drainTo(Collection<? super E> c, int maxElements)
void	forcePut(E e)	Forces adding an element to the queue, without doing size checks.
Iterator<E>	iterator()
boolean	offer(E e)
boolean	offer(E e, long timeout, TimeUnit unit)
E	peek()
E	poll()
E	poll(long timeout, TimeUnit unit)
void	put(E e)
int	remainingCapacity()
boolean	remove(Object o)
int	size()
E	take()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

isEmpty, removeAll, retainAll, 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

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, remove

Constructor Detail

SizeBlockingQueue

public SizeBlockingQueue(BlockingQueue<E> queue,
                         int capacity)

Method Detail

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

capacity

public int capacity()

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>

peek

public E peek()

Specified by:

peek in interface Queue<E>

poll

public E poll()

Specified by:

poll in interface Queue<E>

poll

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

Specified by:

poll in interface BlockingQueue<E>

Throws:

InterruptedException

remove

public boolean remove(Object o)

Specified by:

remove in interface BlockingQueue<E>

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

forcePut

public void forcePut(E e)
              throws InterruptedException

Forces adding an element to the queue, without doing size checks.

Throws:

InterruptedException

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 e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<E>

Throws:

InterruptedException

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>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface BlockingQueue<E>

Specified by:

contains in interface Collection<E>

Overrides:

contains in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Overrides:

containsAll in class AbstractCollection<E>