Package org.apache.hadoop.hbase.util

Class BoundedPriorityBlockingQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.apache.hadoop.hbase.util.BoundedPriorityBlockingQueue<E>

All Implemented Interfaces:

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

@Private
@Stable
public class BoundedPriorityBlockingQueue<E>
extends AbstractQueue<E>
implements BlockingQueue<E>

A generic bounded blocking Priority-Queue. The elements of the priority queue are ordered according to the Comparator provided at queue construction time. If multiple elements have the same priority this queue orders them in FIFO (first-in-first-out) manner. The head of this queue is the least element with respect to the specified ordering. If multiple elements are tied for least value, the head is the first one inserted. The queue retrieval operations poll, remove, peek, and element access the element at the head of the queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BoundedPriorityBlockingQueue.PriorityQueue<E>

Field Summary

Fields

Modifier and Type	Field	Description
private final ReentrantLock	lock
private final Condition	notEmpty
private final Condition	notFull
private final BoundedPriorityBlockingQueue.PriorityQueue<E>	queue

Constructor Summary

Constructors

Constructor	Description
BoundedPriorityBlockingQueue(int capacity, Comparator<? super E> comparator)	Creates a PriorityQueue with the specified capacity that orders its elements according to the specified comparator.

Method Summary

Modifier and Type	Method	Description
Comparator<? super E>	comparator()
boolean	contains(Object o)
int	drainTo(Collection<? super E> c)
int	drainTo(Collection<? super E> c, int maxElements)
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()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, 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

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

Field Details

lock

private final ReentrantLock lock

notEmpty

private final Condition notEmpty

notFull

private final Condition notFull

queue

private final BoundedPriorityBlockingQueue.PriorityQueue<E> queue

Constructor Details

BoundedPriorityBlockingQueue

public BoundedPriorityBlockingQueue(int capacity,
 Comparator<? super E> comparator)

Creates a PriorityQueue with the specified capacity that orders its elements according to the specified comparator.

Parameters:

capacity - the capacity of this queue

comparator - the comparator that will be used to order this priority queue

Method Details

offer

public boolean offer(E e)

Specified by:

offer in interface BlockingQueue<E>

Specified by:

offer in interface Queue<E>

put

public void put(E e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<E>

Throws:

InterruptedException

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

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

peek

public E peek()

Specified by:

peek in interface Queue<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>

comparator

public Comparator<? super E> comparator()

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<E>

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>

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>

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>