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.17 by tim, Thu Jul 31 19:49:42 2003 UTC vs.
Revision 1.21 by dholmes, Tue Aug 5 06:49:51 2003 UTC

# Line 3 | Line 3
3   /**
4   * An unbounded priority queue based on a priority heap.  This queue orders
5   * elements according to an order specified at construction time, which is
6 < * specified in the same manner as {@link java.util.TreeSet} and {@link java.util.TreeMap}:
7 < * elements are ordered
6 > * specified in the same manner as {@link java.util.TreeSet} and
7 > * {@link java.util.TreeMap}: elements are ordered
8   * either according to their <i>natural order</i> (see {@link Comparable}), or
9 < * according to a {@link java.util.Comparator}, depending on which constructor is used.
10 < * The <em>head</em> of this queue is the least element with respect to the
11 < * specified ordering. If multiple elements are tied for least value, the
9 > * according to a {@link java.util.Comparator}, depending on which
10 > * constructor is used.
11 > * <p>The <em>head</em> of this queue is the <em>least</em> element with
12 > * respect to the specified ordering.
13 > * If multiple elements are tied for least value, the
14   * head is one of those elements. A priority queue does not permit
15   * <tt>null</tt> elements.
16   *
# Line 20 | Line 22
22   *
23   * <p>A priority queue has a <i>capacity</i>.  The capacity is the
24   * size of the array used internally to store the elements on the
25 < * queue.  It is always at least as large as the queue size.  As
25 > * queue.
26 > * It is always at least as large as the queue size.  As
27   * elements are added to a priority queue, its capacity grows
28   * automatically.  The details of the growth policy are not specified.
29   *
# Line 38 | Line 41
41   * @author Josh Bloch
42   */
43   public class PriorityQueue<E> extends AbstractQueue<E>
44 <    implements Queue<E>, java.io.Serializable {
44 >    implements Sorted, Queue<E>, java.io.Serializable {
45  
46      private static final int DEFAULT_INITIAL_CAPACITY = 11;
47  
# Line 75 | Line 78 | public class PriorityQueue<E> extends Ab
78      private transient int modCount = 0;
79  
80      /**
81 <     * Create a <tt>PriorityQueue</tt> with the default initial capacity
81 >     * Creates a <tt>PriorityQueue</tt> with the default initial capacity
82       * (11) that orders its elements according to their natural
83       * ordering (using <tt>Comparable</tt>.)
84       */
# Line 84 | Line 87 | public class PriorityQueue<E> extends Ab
87      }
88  
89      /**
90 <     * Create a <tt>PriorityQueue</tt> with the specified initial capacity
90 >     * Creates a <tt>PriorityQueue</tt> with the specified initial capacity
91       * that orders its elements according to their natural ordering
92       * (using <tt>Comparable</tt>.)
93       *
# Line 95 | Line 98 | public class PriorityQueue<E> extends Ab
98      }
99  
100      /**
101 <     * Create a <tt>PriorityQueue</tt> with the specified initial capacity
101 >     * Creates a <tt>PriorityQueue</tt> with the specified initial capacity
102       * that orders its elements according to the specified comparator.
103       *
104       * @param initialCapacity the initial capacity for this priority queue.
# Line 113 | Line 116 | public class PriorityQueue<E> extends Ab
116      }
117  
118      /**
119 <     * Create a <tt>PriorityQueue</tt> containing the elements in the specified
120 <     * collection.  The priority queue has an initial capacity of 110% of the
121 <     * size of the specified collection; or 1 if the collection is empty.
119 >     * Creates a <tt>PriorityQueue</tt> containing the elements in the
120 >     * specified collection.  
121 >     * The priority queue has an initial capacity of 110% of the
122 >     * size of the specified collection or 1 if the collection is empty.
123       * If the specified collection
124       * implements the {@link Sorted} interface, the priority queue will be
125       * sorted according to the same comparator, or according to its elements'
# Line 142 | Line 146 | public class PriorityQueue<E> extends Ab
146          this.queue = new Object[initialCapacity + 1];
147  
148          if (c instanceof Sorted) {
149 <            // FIXME: this code assumes too much
146 <            this.comparator = (Comparator<? super E>) ((Sorted)c).comparator();
147 <            for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
148 <                queue[++size] = i.next();
149 >            comparator = (Comparator<? super E>)((Sorted)c).comparator();
150          } else {
151              comparator = null;
151 –            for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
152 –                add(i.next());
152          }
153 +
154 +        for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
155 +            add(i.next());
156      }
157  
158      // Queue Methods
# Line 158 | Line 160 | public class PriorityQueue<E> extends Ab
160      /**
161       * Add the specified element to this priority queue.
162       *
161 –     * @param element the element to add.
163       * @return <tt>true</tt>
164       * @throws ClassCastException if the specified element cannot be compared
165       * with elements currently in the priority queue according
166       * to the priority queue's ordering.
167 <     * @throws NullPointerException if the specified element is null.
167 >     * @throws NullPointerException if the specified element is <tt>null</tt>.
168       */
169 <    public boolean offer(E element) {
170 <        if (element == null)
169 >    public boolean offer(E o) {
170 >        if (o == null)
171              throw new NullPointerException();
172          modCount++;
173          ++size;
# Line 178 | Line 179 | public class PriorityQueue<E> extends Ab
179              queue = newQueue;
180          }
181  
182 <        queue[size] = element;
182 >        queue[size] = o;
183          fixUp(size);
184          return true;
185      }
# Line 203 | Line 204 | public class PriorityQueue<E> extends Ab
204       * with elements currently in the priority queue according
205       * to the priority queue's ordering.
206       */
207 <    public boolean add(E element) {
208 <        return super.add(element);
207 >    public boolean add(E o) {
208 >        return super.add(o);
209      }
210  
211      /**
211 –     * @throws NullPointerException if any element is <tt>null</tt>.
212       * @throws ClassCastException if any element cannot be compared
213       * with elements currently in the priority queue according
214       * to the priority queue's ordering.
215 +     * @throws NullPointerException if <tt>c</tt> or any element in <tt>c</tt>
216 +     * is <tt>null</tt>
217       */
218      public boolean addAll(Collection<? extends E> c) {
219          return super.addAll(c);

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines