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

Comparing jsr166/src/main/java/util/Queue.java (file contents):
Revision 1.8 by dholmes, Mon Jul 28 04:11:54 2003 UTC vs.
Revision 1.13 by dholmes, Mon Aug 4 01:54:13 2003 UTC

# Line 8 | Line 8 | package java.util;
8  
9   /**
10   * A collection designed for holding elements prior to processing.
11 < * Besides basic {@link Collection} operations, queues provide
11 > * Besides basic {@link java.util.Collection Collection} operations, queues provide
12   * additional insertion, extraction, and inspection operations.
13   *
14   * <p>Queues typically, but do not necessarily, order elements in a
# Line 18 | Line 18 | package java.util;
18   * stacks) which order the elements LIFO (last-in-first-out).
19   * Whatever the ordering used, the <em>head</em> of the queue is that element
20   * which would be removed by a call to {@link #remove() } or {@link #poll()}.
21 < * Every Queue implementation must specify its ordering guarantees.
21 > * Every <tt>Queue</tt> implementation must specify its ordering guarantees.
22   *
23 < * <p>The {@link #offer(E)} method adds an element if possible, otherwise
24 < * returning <tt>false</tt>.  This differs from the {@link
25 < * Collections#add(Object)} method, which throws an unchecked exception upon
23 > * <p>The {@link #offer offer} method adds an element if possible, otherwise
24 > * returning <tt>false</tt>.  This differs from the
25 > * {@link java.util.Collection#add Collection.add}
26 > * method, which throws an unchecked exception upon
27   * failure. It is designed for use in collections in which failure to
28   * add is a normal, rather than exceptional occurrence, for example,
29   * in fixed-capacity (or &quot;bounded&quot;) queues.
30 < *
30 > *
31   * <p>The {@link #remove()} and {@link #poll()} methods remove and
32   * return the head of the queue.
33   * Exactly which element is removed from the queue is a
# Line 37 | Line 38 | package java.util;
38   * while the <tt>poll()</tt> method returns <tt>null</tt>.
39   *
40   * <p>The {@link #element()} and {@link #peek()} methods return, but do
41 < * not delete, the head of the queue.
41 > * not remove, the head of the queue.
42   *
43   * <p>The <tt>Queue</tt> interface does not define the <i>blocking queue
44   * methods</i>, which are common in concurrent programming.  These methods,
# Line 57 | Line 58 | package java.util;
58   * <a href="{@docRoot}/../guide/collections/index.html">
59   * Java Collections Framework</a>.
60   *
61 < * @see Collection
61 > * @see java.util.Collection
62   * @see LinkedList
63   * @see PriorityQueue
64   * @see java.util.concurrent.LinkedQueue
# Line 73 | Line 74 | public interface Queue<E> extends Collec
74      /**
75       * Add the specified element to this queue, if possible.
76       *
77 <     * @param element the element to add.
78 <     * @return <tt>true</tt> if it was possible to add the element to
79 <     * this queue.
77 >     * @param o the element to add.
78 >     * @return <tt>true</tt> if it was possible to add the element to
79 >     * this queue, else <tt>false</tt>
80       */
81 <    boolean offer(E element);
81 >    boolean offer(E o);
82  
83      /**
84       * Retrieve and remove the head of this queue, if it is available.
85       *
86       * @return the head of this queue, or <tt>null</tt> if this
87 <     *         queue is empty.
87 >     *         queue is empty.
88       */
89      E poll();
90  
91      /**
92 <     * Retrieve and remove the head of this queue.  
92 >     * Retrieve and remove the head of this queue.
93       * This method differs
94 <     * from the <tt>poll</tt> method in that it throws an exception if the
95 <     * queue is empty.
94 >     * from the <tt>poll</tt> method in that it throws an exception if this
95 >     * queue is empty.
96       *
97       * @return the head of this queue.
98       * @throws NoSuchElementException if this queue is empty.
99       */
100 <    E remove() throws NoSuchElementException;
100 >    E remove();
101  
102      /**
103 <     * Retrieve, but do not remove, the head of this queue, or <tt>null</tt>
104 <     * if this queue is empty.  This method differs from the <tt>poll</tt>
105 <     * method only in that this method does not remove the element from
103 >     * Retrieve, but do not remove, the head of this queue.
104 >     * This method differs from the <tt>poll</tt>
105 >     * method only in that this method does not remove the head element from
106       * this queue.
107       *
108       * @return the head of this queue, or <tt>null</tt> if this queue is empty.
# Line 110 | Line 111 | public interface Queue<E> extends Collec
111  
112      /**
113       * Retrieve, but do not remove, the head of this queue.  This method
114 <     * differs from the <tt>peek</tt> method only in that it throws an
114 >     * differs from the <tt>peek</tt> method only in that it throws an
115       * exception if this queue is empty.
116       *
117       * @return the head of this queue.
118       * @throws NoSuchElementException if this queue is empty.
119       */
120 <    E element() throws NoSuchElementException;
120 >    E element();
121   }
122  
123  

Diff Legend

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