Class Overview
PriorityQueue holds elements on a priority heap, which orders elements
according to the comparator specified at construction or their natural order.
If the queue uses natural order, any element that is not comparable is not
permitted to insert to the queue.
The least element of the specified ordering is stored at the head of the
queue and the greatest element is stored at the tail of the queue.
PriorityQueue is not synchronized. If multiple threads will access it
concurrently, use the PriorityBlockingQueue.
Summary
| Public Constructors |
|
|
PriorityQueue()
Constructs a priority queue with the capacity of 11 and natural ordering.
|
|
|
PriorityQueue(int initialCapacity)
Constructs a priority queue with specified capacity and natural ordering.
|
|
|
PriorityQueue(int initialCapacity, Comparator<? super E> comparator)
Constructs a priority queue with specified capacity and comparator.
|
|
|
PriorityQueue(Collection<? extends E> c)
Constructs a priority queue that contains the elements of a collection.
|
|
|
PriorityQueue(PriorityQueue<? extends E> c)
Constructs a priority queue that contains the elements of another
priority queue.
|
|
|
PriorityQueue(SortedSet<? extends E> c)
Constructs a priority queue that contains the elements of a sorted set.
|
| Public Methods |
|
boolean
|
add(E o)
Adds the specified object to the priority queue.
|
|
void
|
clear()
Removes all the elements of the priority queue.
|
|
Comparator<? super E>
|
comparator()
Gets the comparator of the priority queue.
|
|
Iterator<E>
|
iterator()
Gets the iterator of the priority queue, which will not return elements
in any specified ordering.
|
|
boolean
|
offer(E o)
Inserts the element to the priority queue.
|
|
E
|
peek()
Gets but not removes the head of the queue.
|
|
E
|
poll()
Gets and removes the head of the queue.
|
|
boolean
|
remove(Object o)
Removes the specified object of the priority queue.
|
|
int
|
size()
Gets the size of the priority queue.
|
|
[Expand]
Inherited Methods |
From class java.util.AbstractQueue
|
boolean
|
add(E o)
Adds an element to the queue.
|
|
boolean
|
addAll(Collection<? extends E> c)
Adds all the elements of a collection to the queue.
|
|
void
|
clear()
Removes all elements of the queue.
|
|
E
|
element()
Gets but not removes the element in the head of the queue.
|
|
E
|
remove()
Gets and removes the element in the head of the queue.
|
|
From class java.util.AbstractCollection
|
boolean
|
add(E object)
If the specified element is not contained within this collection, and
addition of this element succeeds, then true will be returned.
|
|
boolean
|
addAll(Collection<? extends E> collection)
Adds the objects in the specified Collection to this Collection.
|
|
void
|
clear()
Removes all the elements in this collection.
|
|
boolean
|
contains(Object object)
Searches this Collection for the specified object.
|
|
boolean
|
containsAll(Collection<?> collection)
Searches this Collection for all objects in the specified Collection.
|
|
boolean
|
isEmpty()
Returns true if the collection has no element, otherwise false.
|
|
abstract
Iterator<E>
|
iterator()
Returns an Iterator on the elements of this Collection.
|
|
boolean
|
remove(Object object)
Removes the first occurrence of the specified object from this
Collection.
|
|
boolean
|
removeAll(Collection<?> collection)
Removes all occurrences in this Collection of each object in the
specified Collection.
|
|
boolean
|
retainAll(Collection<?> collection)
Removes all objects from this Collection that are not contained in the
specified Collection.
|
|
abstract
int
|
size()
Returns the number of elements in this Collection.
|
|
<T>
T[]
|
toArray(T[] contents)
Returns an array containing all elements contained in this Collection.
|
|
Object[]
|
toArray()
Returns a new array containing all elements contained in this Collection.
|
|
String
|
toString()
Returns the string representation of this Collection.
|
|
From class java.lang.Object
|
Object
|
clone()
Returns a new instance of the same class as the receiver, whose slots
have been filled in with the values in the slots of the receiver.
|
|
boolean
|
equals(Object o)
Compares the argument to the receiver, and returns true if they represent
the same object using a class specific comparison.
|
|
void
|
finalize()
Called by the virtual machine when there are no longer any (non-weak)
references to the receiver.
|
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of java.lang.Class which represents the class
of the receiver.
|
|
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
final
void
|
notify()
Causes one thread which is wait ing on the receiver to be
made ready to run.
|
|
final
void
|
notifyAll()
Causes all threads which are wait ing on the receiver to
be made ready to run.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of the
receiver.
|
|
final
void
|
wait(long time, int frac)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait(long time)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait()
Causes the thread which sent this message to be made not ready to run
pending some change in the receiver (as indicated by notify
or notifyAll).
|
|
From interface java.lang.Iterable
|
From interface java.util.Collection
|
abstract
boolean
|
add(E object)
Attempts to add object to the contents of this
Collection.
|
|
abstract
boolean
|
addAll(Collection<? extends E> collection)
Attempts to add all of the objects contained in collection
to the contents of this collection.
|
|
abstract
void
|
clear()
Removes all elements from this Collection, leaving it empty.
|
|
abstract
boolean
|
contains(Object object)
Searches this Collection for the specified object.
|
|
abstract
boolean
|
containsAll(Collection<?> collection)
Searches this Collection for all objects in the specified Collection.
|
|
abstract
boolean
|
equals(Object object)
Compares the argument to the receiver, and returns true if they represent
the same object using a class specific comparison.
|
|
abstract
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
abstract
boolean
|
isEmpty()
Returns if this Collection has no elements, a size of zero.
|
|
abstract
Iterator<E>
|
iterator()
Returns an instance of Iterator that may be used to access the
objects contained by this collection.
|
|
abstract
boolean
|
remove(Object object)
Removes the first occurrence of the specified object from this
Collection.
|
|
abstract
boolean
|
removeAll(Collection<?> collection)
Removes all occurrences in this Collection of each object in the
specified Collection.
|
|
abstract
boolean
|
retainAll(Collection<?> collection)
Removes all objects from this Collection that are not also found in the
contents of collection.
|
|
abstract
int
|
size()
Returns a count of how many objects are contained by this collection.
|
|
abstract
<T>
T[]
|
toArray(T[] array)
Returns an array containing all elements contained in this Collection.
|
|
abstract
Object[]
|
toArray()
Returns a new array containing all elements contained in this Collection.
|
|
From interface java.util.Queue
|
abstract
E
|
element()
Gets but not removes the element in the head of the queue.
|
|
abstract
boolean
|
offer(E o)
Inserts the specified element into the queue provided that the condition
allows such an operation.
|
|
abstract
E
|
peek()
Gets but not removes the element in the head of the queue, or throws
exception if there is no element in the queue.
|
|
abstract
E
|
poll()
Gets and removes the element in the head of the queue, or returns null if
there is no element in the queue.
|
|
abstract
E
|
remove()
Gets and removes the element in the head of the queue.
|
|
Public Constructors
public
PriorityQueue
()
Constructs a priority queue with the capacity of 11 and natural ordering.
public
PriorityQueue
(int initialCapacity)
Constructs a priority queue with specified capacity and natural ordering.
Parameters
| initialCapacity
| the specified capacity. |
public
PriorityQueue
(int initialCapacity, Comparator<? super E> comparator)
Constructs a priority queue with specified capacity and comparator.
Parameters
| initialCapacity
| the specified capacity. |
| comparator
| the specified comparator. If it is null, the natural
ordering will be used. |
public
PriorityQueue
(Collection<? extends E> c)
Constructs a priority queue that contains the elements of a collection.
The constructed priority queue has the initial capacity of 110% the
collection. And the priority queue uses natural ordering to order its
elements.
Parameters
| c
| the collection whose elements will be added to the priority
queue to be constructed. |
Throws
| ClassCastException
| if any of the elements in the collection is
not comparable. |
|
| if any of the elements in the collection is
null.
|
public
PriorityQueue
(PriorityQueue<? extends E> c)
Constructs a priority queue that contains the elements of another
priority queue. The constructed priority queue has the initial capacity
of 110% the latter one. And the two priority queue has the same
comparator.
Parameters
| c
| the priority queue whose elements will be added to the priority
queue to be constructed.
|
public
PriorityQueue
(SortedSet<? extends E> c)
Constructs a priority queue that contains the elements of a sorted set.
The constructed priority queue has the initial capacity of 110% the
sorted set. And the priority queue has the same comparator of the sorted
set.
Parameters
| c
| the sorted set whose elements will be added to the priority
queue to be constructed.
|
Public Methods
public
boolean
add
(E o)
Adds the specified object to the priority queue.
Parameters
| o
| the object to be added. |
Throws
| ClassCastException
| if the element cannot be compared with the
elements in the priority queue using the ordering of the priority
queue. |
|
| if the element is null.
|
public
void
clear
()
Removes all the elements of the priority queue.
public
Comparator<? super E>
comparator
()
Gets the comparator of the priority queue.
Returns
- the comparator of the priority queue. Null if the natural
ordering is used.
public
Iterator<E>
iterator
()
Gets the iterator of the priority queue, which will not return elements
in any specified ordering.
Returns
- the iterator of the priority queue.
public
boolean
offer
(E o)
Inserts the element to the priority queue.
Throws
| ClassCastException
| if the element cannot be compared with the
elements in the priority queue using the ordering of the priority
queue. |
|
| if the element is null.
|
public
E
peek
()
Gets but not removes the head of the queue.
Returns
- the head of the queue. Null if the queue is empty.
public
E
poll
()
Gets and removes the head of the queue.
Returns
- the head of the queue. Null if the queue is empty.
public
boolean
remove
(Object o)
Removes the specified object of the priority queue.
Parameters
| o
| the object to be removed. |
Returns
- true if the object is in the priority queue, false if the object
is not in the priority queue.
public
int
size
()
Gets the size of the priority queue. If the size of the queue is greater
than the Integer.MAX, then it returns Integer.MAX.
Returns
- the size of the priority queue.