Package fr.ifremer.isisfish.simulator.launcher

Class JDKPriorityBlockingQueue<E>

java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
fr.ifremer.isisfish.simulator.launcher.JDKPriorityBlockingQueue<E>
Type Parameters:
E - element in queue
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>
Direct Known Subclasses:
SimulationQueue
public class JDKPriorityBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
It's based on PriorityBlockingQueue code, because PriorityBlockingQueue use private field for ReentrantLock :(
Author:
poussin
See Also:

  • Field Details

  • Constructor Details

    • JDKPriorityBlockingQueue

      public JDKPriorityBlockingQueue()
      Creates a PriorityBlockingQueue with the default initial capacity (11) that orders its elements according to their natural ordering.

    • JDKPriorityBlockingQueue

      public JDKPriorityBlockingQueue(int initialCapacity)
      Creates a PriorityBlockingQueue with the specified initial capacity that orders its elements according to their natural ordering.
      Parameters:
      initialCapacity - the initial capacity for this priority queues
      Throws:
      IllegalArgumentException - if initialCapacity is less than 1

    • JDKPriorityBlockingQueue

      public JDKPriorityBlockingQueue(int initialCapacity, Comparator<? super E> comparator)
      Creates a PriorityBlockingQueue with the specified initial capacity that orders its elements according to the specified comparator.
      Parameters:
      initialCapacity - the initial capacity for this priority queues
      comparator - the comparator that will be used to order this priority queues. If null, the natural ordering of the elements will be used.
      Throws:
      IllegalArgumentException - if initialCapacity is less than 1

    • JDKPriorityBlockingQueue

      public JDKPriorityBlockingQueue(Collection<? extends E> c)
      Creates a PriorityBlockingQueue containing the elements in the specified collection. If the specified collection is a SortedSet or a PriorityQueue, this priority queues will be ordered according to the same ordering. Otherwise, this priority queues will be ordered according to the natural ordering of its elements.
      Parameters:
      c - the collection whose elements are to be placed into this priority queues
      Throws:
      ClassCastException - if elements of the specified collection cannot be compared to one another according to the priority queues's ordering
      NullPointerException - if the specified collection or any of its elements are null

  • Method Details

    • add

      public boolean add(E e)
      Inserts the specified element into this priority queues.
      Specified by:
      add in interface BlockingQueue<E>
      Specified by:
      add in interface Collection<E>
      Specified by:
      add in interface Queue<E>
      Overrides:
      add in class AbstractQueue<E>
      Parameters:
      e - the element to add
      Returns:
      true (as specified by Collection.add(E))
      Throws:
      ClassCastException - if the specified element cannot be compared with elements currently in the priority queues according to the priority queues's ordering
      NullPointerException - if the specified element is null

    • offer

      public boolean offer(E e)
      Inserts the specified element into this priority queues.
      Specified by:
      offer in interface BlockingQueue<E>
      Specified by:
      offer in interface Queue<E>
      Parameters:
      e - the element to add
      Returns:
      true (as specified by Queue.offer(E))
      Throws:
      ClassCastException - if the specified element cannot be compared with elements currently in the priority queues according to the priority queues's ordering
      NullPointerException - if the specified element is null

    • put

      public void put(E e)
      Inserts the specified element into this priority queues. As the queues is unbounded this method will never block.
      Specified by:
      put in interface BlockingQueue<E>
      Parameters:
      e - the element to add
      Throws:
      ClassCastException - if the specified element cannot be compared with elements currently in the priority queues according to the priority queues's ordering
      NullPointerException - if the specified element is null

    • offer

      public boolean offer(E e, long timeout, TimeUnit unit)
      Inserts the specified element into this priority queues. As the queues is unbounded this method will never block.
      Specified by:
      offer in interface BlockingQueue<E>
      Parameters:
      e - the element to add
      timeout - This parameter is ignored as the method never blocks
      unit - This parameter is ignored as the method never blocks
      Returns:
      true
      Throws:
      ClassCastException - if the specified element cannot be compared with elements currently in the priority queues according to the priority queues's ordering
      NullPointerException - if the specified element is null

    • 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 queues, or null if this queues uses the natural ordering of its elements.
      Returns:
      the comparator used to order the elements in this queues, or null if this queues 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()
      Always returns Integer.MAX_VALUE because a PriorityBlockingQueue is not capacity constrained.
      Specified by:
      remainingCapacity in interface BlockingQueue<E>
      Returns:
      Integer.MAX_VALUE

    • remove

      public boolean remove(Object o)
      Removes a single instance of the specified element from this queues, if it is present. More formally, removes an element e such that o.equals(e), if this queues contains one or more such elements. Returns true if and only if this queues contained the specified element (or equivalently, if this queues changed as a result of the call).
      Specified by:
      remove in interface BlockingQueue<E>
      Specified by:
      remove in interface Collection<E>
      Overrides:
      remove in class AbstractCollection<E>
      Parameters:
      o - element to be removed from this queues, if present
      Returns:
      true if this queues changed as a result of the call

    • contains

      public boolean contains(Object o)
      Returns true if this queues contains the specified element. More formally, returns true if and only if this queues contains at least one element e such that o.equals(e).
      Specified by:
      contains in interface BlockingQueue<E>
      Specified by:
      contains in interface Collection<E>
      Overrides:
      contains in class AbstractCollection<E>
      Parameters:
      o - object to be checked for containment in this queues
      Returns:
      true if this queues contains the specified element

    • toArray

      public Object[] toArray()
      Returns an array containing all of the elements in this queues. 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 queues. (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 queues

    • 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 queues. The queues 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 queues; the runtime type of the returned array is that of the specified array. The returned array elements are in no particular order. If the queues 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 queues.

      If this queues fits in the specified array with room to spare (i.e., the array has more elements than this queues), the element in the array immediately following the end of the queues 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 queues known to contain only strings. The following code can be used to dump the queues 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 queues 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 queues
      Throws:
      ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this queues
      NullPointerException - if the specified array is null

    • iterator

      public Iterator<E> iterator()
      Returns an iterator over the elements in this queues. 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 Collection<E>
      Specified by:
      iterator in interface Iterable<E>
      Specified by:
      iterator in class AbstractCollection<E>
      Returns:
      an iterator over the elements in this queues