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:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.concurrent.BlockingQueue<E>, java.util.Queue<E>

@InterfaceAudience.Private
 @InterfaceStability.Stable
public class BoundedPriorityBlockingQueue<E>
extends java.util.AbstractQueue<E>
implements java.util.concurrent.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.

Constructor Summary

Constructors

Constructor and Description
BoundedPriorityBlockingQueue(int capacity, java.util.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 and Description
java.util.Comparator<? super E>	comparator()
boolean	contains(java.lang.Object o)
int	drainTo(java.util.Collection<? super E> c)
int	drainTo(java.util.Collection<? super E> c, int maxElements)
java.util.Iterator<E>	iterator()
boolean	offer(E e)
boolean	offer(E e, long timeout, java.util.concurrent.TimeUnit unit)
E	peek()
E	poll()
E	poll(long timeout, java.util.concurrent.TimeUnit unit)
void	put(E e)
int	remainingCapacity()
boolean	remove(java.lang.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.Queue

element, remove

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BoundedPriorityBlockingQueue

public BoundedPriorityBlockingQueue(int capacity,
                                    java.util.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 Detail

offer

public boolean offer(E e)

Specified by:

offer in interface java.util.concurrent.BlockingQueue<E>

Specified by:

offer in interface java.util.Queue<E>

put

public void put(E e)
         throws java.lang.InterruptedException

Specified by:

put in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

offer

public boolean offer(E e,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Specified by:

offer in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

take

public E take()
       throws java.lang.InterruptedException

Specified by:

take in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

poll

public E poll()

Specified by:

poll in interface java.util.Queue<E>

poll

public E poll(long timeout,
              java.util.concurrent.TimeUnit unit)
       throws java.lang.InterruptedException

Specified by:

poll in interface java.util.concurrent.BlockingQueue<E>

Throws:

java.lang.InterruptedException

peek

public E peek()

Specified by:

peek in interface java.util.Queue<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in class java.util.AbstractCollection<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in class java.util.AbstractCollection<E>

comparator

public java.util.Comparator<? super E> comparator()

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface java.util.concurrent.BlockingQueue<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.concurrent.BlockingQueue<E>

Overrides:

remove in class java.util.AbstractCollection<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.concurrent.BlockingQueue<E>

Overrides:

contains in class java.util.AbstractCollection<E>

drainTo

public int drainTo(java.util.Collection<? super E> c)

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<E>

drainTo

public int drainTo(java.util.Collection<? super E> c,
                   int maxElements)

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<E>