ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/PriorityQueue.java
(Generate patch)

Comparing jsr166/src/main/java/util/PriorityQueue.java (file contents):
Revision 1.22 by dl, Tue Aug 5 12:11:08 2003 UTC vs.
Revision 1.28 by dl, Wed Aug 13 14:11:59 2003 UTC

# Line 1 | Line 1
1   package java.util;
2  
3   /**
4 < * An unbounded priority queue based on a priority heap.  This queue orders
4 > * An unbounded priority {@linkplain Queue queue} based on a priority heap.  
5 > * This queue orders
6   * elements according to an order specified at construction time, which is
7   * specified in the same manner as {@link java.util.TreeSet} and
8   * {@link java.util.TreeMap}: elements are ordered
# Line 80 | Line 81 | public class PriorityQueue<E> extends Ab
81      /**
82       * Creates a <tt>PriorityQueue</tt> with the default initial capacity
83       * (11) that orders its elements according to their natural
84 <     * ordering (using <tt>Comparable</tt>.)
84 >     * ordering (using <tt>Comparable</tt>).
85       */
86      public PriorityQueue() {
87          this(DEFAULT_INITIAL_CAPACITY, null);
# Line 89 | Line 90 | public class PriorityQueue<E> extends Ab
90      /**
91       * Creates a <tt>PriorityQueue</tt> with the specified initial capacity
92       * that orders its elements according to their natural ordering
93 <     * (using <tt>Comparable</tt>.)
93 >     * (using <tt>Comparable</tt>).
94       *
95       * @param initialCapacity the initial capacity for this priority queue.
96 +     * @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
97 +     * than 1
98       */
99      public PriorityQueue(int initialCapacity) {
100          this(initialCapacity, null);
# Line 108 | Line 111 | public class PriorityQueue<E> extends Ab
111       * @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
112       * than 1
113       */
114 <    public PriorityQueue(int initialCapacity, Comparator<? super E> comparator) {
114 >    public PriorityQueue(int initialCapacity,
115 >                         Comparator<? super E> comparator) {
116          if (initialCapacity < 1)
117              throw new IllegalArgumentException();
118          this.queue = new Object[initialCapacity + 1];
# Line 155 | Line 159 | public class PriorityQueue<E> extends Ab
159       * specified collection.  The priority queue has an initial
160       * capacity of 110% of the size of the specified collection or 1
161       * if the collection is empty.  If the specified collection is an
162 <     * instance of a {@link SortedSet} or is another
162 >     * instance of a {@link java.util.SortedSet} or is another
163       * <tt>PriorityQueue</tt>, the priority queue will be sorted
164       * according to the same comparator, or according to its elements'
165       * natural order if the collection is sorted according to its
# Line 172 | Line 176 | public class PriorityQueue<E> extends Ab
176       */
177      public PriorityQueue(Collection<? extends E> c) {
178          initializeArray(c);
179 <        if (c instanceof SortedSet<? extends E>) {
180 <            SortedSet<? extends E> s = (SortedSet<? extends E>) c;
179 >        if (c instanceof SortedSet) {
180 >            // @fixme double-cast workaround for compiler
181 >            SortedSet<? extends E> s = (SortedSet<? extends E>) (SortedSet)c;
182              comparator = (Comparator<? super E>)s.comparator();
183              fillFromSorted(s);
184 <        }
180 <        else if (c instanceof PriorityQueue<? extends E>) {
184 >        } else if (c instanceof PriorityQueue) {
185              PriorityQueue<? extends E> s = (PriorityQueue<? extends E>) c;
186              comparator = (Comparator<? super E>)s.comparator();
187              fillFromSorted(s);
188 <        }
185 <        else {
188 >        } else {
189              comparator = null;
190              fillFromUnsorted(c);
191          }
# Line 256 | Line 259 | public class PriorityQueue<E> extends Ab
259              
260      // Queue Methods
261  
262 +
263 +
264      /**
265       * Add the specified element to this priority queue.
266       *
# Line 290 | Line 295 | public class PriorityQueue<E> extends Ab
295          return (E) queue[1];
296      }
297  
298 <    // Collection Methods
294 <
295 <    // these first two override just to get the throws docs
298 >    // Collection Methods - the first two override to update docs
299  
300      /**
301 <     * @throws NullPointerException if the specified element is <tt>null</tt>.
301 >     * Adds the specified element to this queue.
302 >     * @return <tt>true</tt> (as per the general contract of
303 >     * <tt>Collection.add</tt>).
304 >     *
305 >     * @throws NullPointerException {@inheritDoc}
306       * @throws ClassCastException if the specified element cannot be compared
307       * with elements currently in the priority queue according
308       * to the priority queue's ordering.
# Line 304 | Line 311 | public class PriorityQueue<E> extends Ab
311          return super.add(o);
312      }
313  
314 +  
315      /**
316 +     * Adds all of the elements in the specified collection to this queue.
317 +     * The behavior of this operation is undefined if
318 +     * the specified collection is modified while the operation is in
319 +     * progress.  (This implies that the behavior of this call is undefined if
320 +     * the specified collection is this queue, and this queue is nonempty.)
321 +     * <p>
322 +     * This implementation iterates over the specified collection, and adds
323 +     * each object returned by the iterator to this collection, in turn.
324 +     * @throws NullPointerException {@inheritDoc}
325       * @throws ClassCastException if any element cannot be compared
326       * with elements currently in the priority queue according
327       * to the priority queue's ordering.
311     * @throws NullPointerException if <tt>c</tt> or any element in <tt>c</tt>
312     * is <tt>null</tt>
328       */
329      public boolean addAll(Collection<? extends E> c) {
330          return super.addAll(c);
331      }
332  
333 +
334 + /**
335 +     * Removes a single instance of the specified element from this
336 +     * queue, if it is present.  More formally,
337 +     * removes an element <tt>e</tt> such that <tt>(o==null ? e==null :
338 +     * o.equals(e))</tt>, if the queue contains one or more such
339 +     * elements.  Returns <tt>true</tt> if the queue contained the
340 +     * specified element (or equivalently, if the queue changed as a
341 +     * result of the call).
342 +     *
343 +     * <p>This implementation iterates over the queue looking for the
344 +     * specified element.  If it finds the element, it removes the element
345 +     * from the queue using the iterator's remove method.<p>
346 +     *
347 +     */
348      public boolean remove(Object o) {
349          if (o == null)
350              return false;
# Line 337 | Line 367 | public class PriorityQueue<E> extends Ab
367          return false;
368      }
369  
370 +    /**
371 +     * Returns an iterator over the elements in this queue. The iterator
372 +     * does not return the elements in any particular order.
373 +     *
374 +     * @return an iterator over the elements in this queue.
375 +     */
376      public Iterator<E> iterator() {
377          return new Itr();
378      }
# Line 393 | Line 429 | public class PriorityQueue<E> extends Ab
429          }
430      }
431  
396    /**
397     * Returns the number of elements in this priority queue.
398     *
399     * @return the number of elements in this priority queue.
400     */
432      public int size() {
433          return size;
434      }
# Line 495 | Line 526 | public class PriorityQueue<E> extends Ab
526          }
527      }
528  
529 +
530 +    /**
531 +     * Returns the comparator used to order this collection, or <tt>null</tt>
532 +     * if this collection is sorted according to its elements natural ordering
533 +     * (using <tt>Comparable</tt>).
534 +     *
535 +     * @return the comparator used to order this collection, or <tt>null</tt>
536 +     * if this collection is sorted according to its elements natural ordering.
537 +     */
538      public Comparator<? super E> comparator() {
539          return comparator;
540      }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines