Liking cljdoc? Tell your friends :D

jdk.util.concurrent.PriorityBlockingQueue

An unbounded java.util.concurrent.blocking queue that uses the same ordering rules as class PriorityQueue and supplies blocking retrieval operations. While this queue is logically unbounded, attempted additions may fail due to resource exhaustion (causing OutOfMemoryError). This class does not permit null elements. A priority queue relying on java.lang.natural ordering also does not permit insertion of non-comparable objects (doing so results in ClassCastException).

This class and its iterator implement all of the optional methods of the Collection and Iterator interfaces. The Iterator provided in method iterator() is not guaranteed to traverse the elements of the PriorityBlockingQueue in any particular order. If you need ordered traversal, consider using Arrays.sort(pq.toArray()). Also, method drainTo can be used to remove some or all elements in priority order and place them in another collection.

Operations on this class make no guarantees about the ordering of elements with equal priority. If you need to enforce an ordering, you can define custom classes or comparators that use a secondary key to break ties in primary priority values. For example, here is a class that applies first-in-first-out tie-breaking to comparable elements. To use it, you would insert a new FIFOEntry(anEntry) instead of a plain entry object.

class FIFOEntry<E extends Comparable<? super E>> implements Comparable<FIFOEntry<E>> { static final AtomicLong seq = new AtomicLong(0); final long seqNum; final E entry; public FIFOEntry(E entry) { seqNum = seq.getAndIncrement(); this.entry = entry; } public E getEntry() { return entry; } public int compareTo(FIFOEntry<E> other) { int res = entry.compareTo(other.entry); if (res == 0 && other.entry != this.entry) res = (seqNum < other.seqNum ? -1 : 1); return res; } }

This class is a member of the

Java Collections Framework.

An unbounded java.util.concurrent.blocking queue that uses
the same ordering rules as class PriorityQueue and supplies
blocking retrieval operations.  While this queue is logically
unbounded, attempted additions may fail due to resource exhaustion
(causing OutOfMemoryError). This class does not permit
null elements.  A priority queue relying on java.lang.natural ordering also does not permit insertion of
non-comparable objects (doing so results in
ClassCastException).

This class and its iterator implement all of the
optional methods of the Collection and Iterator interfaces.  The Iterator provided in method iterator() is not guaranteed to traverse the elements of
the PriorityBlockingQueue in any particular order. If you need
ordered traversal, consider using
Arrays.sort(pq.toArray()).  Also, method drainTo
can be used to remove some or all elements in priority
order and place them in another collection.

Operations on this class make no guarantees about the ordering
of elements with equal priority. If you need to enforce an
ordering, you can define custom classes or comparators that use a
secondary key to break ties in primary priority values.  For
example, here is a class that applies first-in-first-out
tie-breaking to comparable elements. To use it, you would insert a
new FIFOEntry(anEntry) instead of a plain entry object.



class FIFOEntry<E extends Comparable<? super E>>
    implements Comparable<FIFOEntry<E>> {
  static final AtomicLong seq = new AtomicLong(0);
  final long seqNum;
  final E entry;
  public FIFOEntry(E entry) {
    seqNum = seq.getAndIncrement();
    this.entry = entry;
  }
  public E getEntry() { return entry; }
  public int compareTo(FIFOEntry<E> other) {
    int res = entry.compareTo(other.entry);
    if (res == 0 && other.entry != this.entry)
      res = (seqNum < other.seqNum ? -1 : 1);
    return res;
  }
}

This class is a member of the

Java Collections Framework.
raw docstring

->priority-blocking-queueclj

(->priority-blocking-queue)
(->priority-blocking-queue initial-capacity)
(->priority-blocking-queue initial-capacity comparator)

Constructor.

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

initial-capacity - the initial capacity for this priority queue - int comparator - the comparator that will be used to order this priority queue. If null, the java.lang.natural ordering of the elements will be used. - java.util.Comparator

throws: java.lang.IllegalArgumentException - if initialCapacity is less than 1

Constructor.

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

initial-capacity - the initial capacity for this priority queue - `int`
comparator - the comparator that will be used to order this priority queue. If null, the java.lang.natural ordering of the elements will be used. - `java.util.Comparator`

throws: java.lang.IllegalArgumentException - if initialCapacity is less than 1
raw docstring

addclj

(add this e)

Inserts the specified element into this priority queue.

e - the element to add - E

returns: true (as specified by Collection.add(E)) - boolean

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

Inserts the specified element into this priority queue.

e - the element to add - `E`

returns: true (as specified by Collection.add(E)) - `boolean`

throws: java.lang.ClassCastException - if the specified element cannot be compared with elements currently in the priority queue according to the priority queue's ordering
raw docstring

clearclj

(clear this)

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

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

comparatorclj

(comparator this)

Returns the comparator used to order the elements in this queue, or null if this queue uses the java.lang.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 - java.util.Comparator<? super E>

Returns the comparator used to order the elements in this queue,
 or null if this queue uses the java.lang.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 - `java.util.Comparator<? super E>`
raw docstring

containsclj

(contains this 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).

o - object to be checked for containment in this queue - java.lang.Object

returns: true if this queue contains the specified element - boolean

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).

o - object to be checked for containment in this queue - `java.lang.Object`

returns: true if this queue contains the specified element - `boolean`
raw docstring

drain-toclj

(drain-to this c)
(drain-to this c max-elements)

Description copied from interface: BlockingQueue

c - the collection to transfer elements into - java.util.Collection max-elements - the maximum number of elements to transfer - int

returns: the number of elements transferred - int

throws: java.lang.UnsupportedOperationException - if addition of elements is not supported by the specified collection

Description copied from interface: BlockingQueue

c - the collection to transfer elements into - `java.util.Collection`
max-elements - the maximum number of elements to transfer - `int`

returns: the number of elements transferred - `int`

throws: java.lang.UnsupportedOperationException - if addition of elements is not supported by the specified collection
raw docstring

iteratorclj

(iterator this)

Returns an iterator over the elements in this queue. The iterator does not return the elements in any particular order.

The returned iterator is weakly consistent.

returns: an iterator over the elements in this queue - java.util.Iterator<E>

Returns an iterator over the elements in this queue. The
 iterator does not return the elements in any particular order.

 The returned iterator is
 weakly consistent.

returns: an iterator over the elements in this queue - `java.util.Iterator<E>`
raw docstring

offerclj

(offer this e)
(offer this e timeout unit)

Inserts the specified element into this priority queue. As the queue is unbounded, this method will never block or return false.

e - the element to add - E timeout - This parameter is ignored as the method never blocks - long unit - This parameter is ignored as the method never blocks - java.util.concurrent.TimeUnit

returns: true (as specified by BlockingQueue.offer) - boolean

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

Inserts the specified element into this priority queue.
 As the queue is unbounded, this method will never block or
 return false.

e - the element to add - `E`
timeout - This parameter is ignored as the method never blocks - `long`
unit - This parameter is ignored as the method never blocks - `java.util.concurrent.TimeUnit`

returns: true (as specified by
  BlockingQueue.offer) - `boolean`

throws: java.lang.ClassCastException - if the specified element cannot be compared with elements currently in the priority queue according to the priority queue's ordering
raw docstring

peekclj

(peek this)

Description copied from interface: Queue

returns: the head of this queue, or null if this queue is empty - E

Description copied from interface: Queue

returns: the head of this queue, or null if this queue is empty - `E`
raw docstring

pollclj

(poll this)
(poll this timeout unit)

Description copied from interface: BlockingQueue

timeout - how long to wait before giving up, in units of unit - long unit - a TimeUnit determining how to interpret the timeout parameter - java.util.concurrent.TimeUnit

returns: the head of this queue, or null if the specified waiting time elapses before an element is available - E

throws: java.lang.InterruptedException - if interrupted while waiting

Description copied from interface: BlockingQueue

timeout - how long to wait before giving up, in units of unit - `long`
unit - a TimeUnit determining how to interpret the timeout parameter - `java.util.concurrent.TimeUnit`

returns: the head of this queue, or null if the
         specified waiting time elapses before an element is available - `E`

throws: java.lang.InterruptedException - if interrupted while waiting
raw docstring

putclj

(put this e)

Inserts the specified element into this priority queue. As the queue is unbounded, this method will never block.

e - the element to add - E

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

Inserts the specified element into this priority queue.
 As the queue is unbounded, this method will never block.

e - the element to add - `E`

throws: java.lang.ClassCastException - if the specified element cannot be compared with elements currently in the priority queue according to the priority queue's ordering
raw docstring

remaining-capacityclj

(remaining-capacity this)

Always returns Integer.MAX_VALUE because a PriorityBlockingQueue is not capacity constrained.

returns: Integer.MAX_VALUE always - int

Always returns Integer.MAX_VALUE because
 a PriorityBlockingQueue is not capacity constrained.

returns: Integer.MAX_VALUE always - `int`
raw docstring

removeclj

(remove this 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).

o - element to be removed from this queue, if present - java.lang.Object

returns: true if this queue changed as a result of the call - boolean

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).

o - element to be removed from this queue, if present - `java.lang.Object`

returns: true if this queue changed as a result of the call - `boolean`
raw docstring

sizeclj

(size this)

Description copied from interface: Collection

returns: the number of elements in this collection - int

Description copied from interface: Collection

returns: the number of elements in this collection - `int`
raw docstring

spliteratorclj

(spliterator this)

Returns a Spliterator over the elements in this queue.

The returned spliterator is weakly consistent.

The Spliterator reports Spliterator.SIZED and Spliterator.NONNULL.

returns: a Spliterator over the elements in this queue - java.util.Spliterator<E>

Returns a Spliterator over the elements in this queue.

 The returned spliterator is
 weakly consistent.

 The Spliterator reports Spliterator.SIZED and
 Spliterator.NONNULL.

returns: a Spliterator over the elements in this queue - `java.util.Spliterator<E>`
raw docstring

takeclj

(take this)

Description copied from interface: BlockingQueue

returns: the head of this queue - E

throws: java.lang.InterruptedException - if interrupted while waiting

Description copied from interface: BlockingQueue

returns: the head of this queue - `E`

throws: java.lang.InterruptedException - if interrupted while waiting
raw docstring

to-arrayclj

(to-array this)
(to-array this 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().

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 - T[]

returns: an array containing all of the elements in this queue - <T> T[]

throws: java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue

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().

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 - `T[]`

returns: an array containing all of the elements in this queue - `<T> T[]`

throws: java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue
raw docstring

to-stringclj

(to-string this)

Description copied from class: AbstractCollection

returns: a string representation of this collection - java.lang.String

Description copied from class: AbstractCollection

returns: a string representation of this collection - `java.lang.String`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close