at.molindo.utils.concurrent
Class BoundedPriorityBlockingQueue<E>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractQueue<E>
          at.molindo.utils.concurrent.BoundedPriorityBlockingQueue<E>

All Implemented Interfaces:

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

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

Constructor Summary

BoundedPriorityBlockingQueue(int capacity)

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

Method Summary

void	clear() Atomically removes all of the elements from this queue.
Comparator<? super E>	comparator() Returns the comparator used to order the elements in this queue, or null if this queue uses the natural ordering of its elements.
boolean	contains(Object o) Returns true if this queue contains the specified element.
int	drainTo(Collection<? super E> c)
int	drainTo(Collection<? super E> c, int maxElements)
Iterator<E>	iterator() Returns an iterator over the elements in this queue.
boolean	offer(E e) Inserts the specified element into this priority queue.
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) Removes a single instance of the specified element from this queue, if it is present.
int	size()
E	take()
Object[]	toArray() Returns an array containing all of the elements in this queue.
<T> T[]	toArray(T[] a) Returns an array containing all of the elements in this queue; the runtime type of the returned array is that of the specified array.
String	toString()

Methods inherited from class java.util.AbstractQueue

add, addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll

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

Constructor Detail

BoundedPriorityBlockingQueue

public BoundedPriorityBlockingQueue(int capacity)

BoundedPriorityBlockingQueue

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

Method Detail

offer

public boolean offer(E e)

Inserts the specified element into this priority queue.

Specified by:

offer in interface BlockingQueue<E>

Specified by:

offer in interface Queue<E>

Parameters:

e - the element to add

Returns:

true if the element was added to this queue, else false

Throws:

ClassCastException - if the specified element cannot be compared with elements currently in the priority queue according to the priority queue's ordering

NullPointerException - if the specified element is null

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

poll

public E poll()

Specified by:

poll in interface Queue<E>

take

public E take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<E>

Throws:

InterruptedException

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>

comparator

public Comparator<? super E> comparator()

Returns the comparator used to order the elements in this queue, or null if this queue uses the natural ordering of its elements.

Returns:

the comparator used to order the elements in this queue, or null if this queue uses the natural ordering of its elements

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<E>

remove

public boolean remove(Object o)

Removes a single instance of the specified element from this queue, if it is present. More formally, removes an element e such that o.equals(e), if this queue contains one or more such elements. Returns true if and only if this queue contained the specified element (or equivalently, if this queue changed as a result of the call).

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface BlockingQueue<E>

Overrides:

remove in class AbstractCollection<E>

Parameters:

o - element to be removed from this queue, if present

Returns:

true if this queue changed as a result of the call

contains

public boolean contains(Object o)

Returns true if this queue contains the specified element. More formally, returns true if and only if this queue contains at least one element e such that o.equals(e).

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface BlockingQueue<E>

Overrides:

contains in class AbstractCollection<E>

Parameters:

o - object to be checked for containment in this queue

Returns:

true if this queue contains the specified element

toArray

public Object[] toArray()

Returns an array containing all of the elements in this queue. The returned array elements are in no particular order.

The returned array will be "safe" in that no references to it are maintained by this queue. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

Returns:

an array containing all of the elements in this queue

toString

public String toString()

Overrides:

toString in class AbstractCollection<E>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<E>

Throws:

UnsupportedOperationException

ClassCastException

NullPointerException

IllegalArgumentException

drainTo

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

Specified by:

drainTo in interface BlockingQueue<E>

Throws:

UnsupportedOperationException

ClassCastException

NullPointerException

IllegalArgumentException

clear

public void clear()

Atomically removes all of the elements from this queue. The queue will be empty after this call returns.

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractQueue<E>

toArray

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

Returns an array containing all of the elements in this queue; the runtime type of the returned array is that of the specified array. The returned array elements are in no particular order. If the queue fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this queue.

If this queue fits in the specified array with room to spare (i.e., the array has more elements than this queue), the element in the array immediately following the end of the queue is set to null.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a queue known to contain only strings. The following code can be used to dump the queue into a newly allocated array of String:

 String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

Parameters:

a - the array into which the elements of the queue are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose

Returns:

an array containing all of the elements in this queue

Throws:

ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue

NullPointerException - if the specified array is null

iterator

public Iterator<E> iterator()

Returns an iterator over the elements in this queue. The iterator does not return the elements in any particular order. The returned Iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

an iterator over the elements in this queue