[cvs] / jsr166 / src / main / java / util / Queue.java Repository:
ViewVC logotype

Diff of /jsr166/src/main/java/util/Queue.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.29, Sat May 14 02:11:52 2005 UTC revision 1.50, Mon Oct 1 00:10:53 2018 UTC
# Line 1  Line 1 
1  /*  /*
2   * Written by Doug Lea with assistance from members of JCP JSR-166   * Written by Doug Lea with assistance from members of JCP JSR-166
3   * Expert Group and released to the public domain, as explained at   * Expert Group and released to the public domain, as explained at
4   * http://creativecommons.org/licenses/publicdomain   * http://creativecommons.org/publicdomain/zero/1.0/
5   */   */
6    
7  package java.util;  package java.util;
8    
9  /**  /**
10   * A collection designed for holding elements prior to processing.   * A collection designed for holding elements prior to processing.
11   * Besides basic {@link java.util.Collection Collection} operations,   * Besides basic {@link Collection} operations, queues provide
12   * queues provide additional insertion, extraction, and inspection   * additional insertion, extraction, and inspection operations.
13   * operations.  Each of these methods exists in two forms: one throws   * Each of these methods exists in two forms: one throws an exception
14   * an exception if the operation fails, the other returns a special   * if the operation fails, the other returns a special value (either
15   * value (either <tt>null</tt> or <tt>false</tt>, depending on the   * {@code null} or {@code false}, depending on the operation).  The
16   * operation).  The latter form of the insert operation is designed   * latter form of the insert operation is designed specifically for
17   * specifically for use with capacity-restricted <tt>Queue</tt>   * use with capacity-restricted {@code Queue} implementations; in most
18   * implementations; in most implementations, insert operations cannot   * implementations, insert operations cannot fail.
19   * fail.   *
20   *   * <table class="striped">
21   * <p>   * <caption>Summary of Queue methods</caption>
22   * <table BORDER CELLPADDING=3 CELLSPACING=1>   *  <thead>
23   *  <tr>   *  <tr>
24   *    <td></td>   *    <td></td>
25   *    <td ALIGN=CENTER><em>Throws exception</em></td>   *    <th scope="col" style="font-weight:normal; font-style:italic">Throws exception</th>
26   *    <td ALIGN=CENTER><em>Special value</em></td>   *    <th scope="col" style="font-weight:normal; font-style:italic">Returns special value</th>
27   *  </tr>   *  </tr>
28     *  </thead>
29     *  <tbody>
30   *  <tr>   *  <tr>
31   *    <td><b>Insert</b></td>   *    <th scope="row">Insert</th>
32   *    <td>{@link #add add(e)}</td>   *    <td>{@link #add(Object) add(e)}</td>
33   *    <td>{@link #offer offer(e)}</td>   *    <td>{@link #offer(Object) offer(e)}</td>
34   *  </tr>   *  </tr>
35   *  <tr>   *  <tr>
36   *    <td><b>Remove</b></td>   *    <th scope="row">Remove</th>
37   *    <td>{@link #remove remove()}</td>   *    <td>{@link #remove() remove()}</td>
38   *    <td>{@link #poll poll()}</td>   *    <td>{@link #poll() poll()}</td>
39   *  </tr>   *  </tr>
40   *  <tr>   *  <tr>
41   *    <td><b>Examine</b></td>   *    <th scope="row">Examine</th>
42   *    <td>{@link #element element()}</td>   *    <td>{@link #element() element()}</td>
43   *    <td>{@link #peek peek()}</td>   *    <td>{@link #peek() peek()}</td>
44   *  </tr>   *  </tr>
45     *  </tbody>
46   * </table>   * </table>
47   *   *
48   * <p>Queues typically, but do not necessarily, order elements in a   * <p>Queues typically, but do not necessarily, order elements in a
# Line 51  Line 54 
54   * element which would be removed by a call to {@link #remove() } or   * element which would be removed by a call to {@link #remove() } or
55   * {@link #poll()}.  In a FIFO queue, all new elements are inserted at   * {@link #poll()}.  In a FIFO queue, all new elements are inserted at
56   * the <em> tail</em> of the queue. Other kinds of queues may use   * the <em> tail</em> of the queue. Other kinds of queues may use
57   * different placement rules.  Every <tt>Queue</tt> implementation   * different placement rules.  Every {@code Queue} implementation
58   * must specify its ordering properties.   * must specify its ordering properties.
59   *   *
60   * <p>The {@link #offer offer} method inserts an element if possible,   * <p>The {@link #offer offer} method inserts an element if possible,
61   * otherwise returning <tt>false</tt>.  This differs from the {@link   * otherwise returning {@code false}.  This differs from the {@link
62   * java.util.Collection#add Collection.add} method, which can fail to   * java.util.Collection#add Collection.add} method, which can fail to
63   * add an element only by throwing an unchecked exception.  The   * add an element only by throwing an unchecked exception.  The
64   * <tt>offer</tt> method is designed for use when failure is a normal,   * {@code offer} method is designed for use when failure is a normal,
65   * rather than exceptional occurrence, for example, in fixed-capacity   * rather than exceptional occurrence, for example, in fixed-capacity
66   * (or &quot;bounded&quot;) queues.   * (or &quot;bounded&quot;) queues.
67   *   *
# Line 66  Line 69 
69   * return the head of the queue.   * return the head of the queue.
70   * Exactly which element is removed from the queue is a   * Exactly which element is removed from the queue is a
71   * function of the queue's ordering policy, which differs from   * function of the queue's ordering policy, which differs from
72   * implementation to implementation. The <tt>remove()</tt> and   * implementation to implementation. The {@code remove()} and
73   * <tt>poll()</tt> methods differ only in their behavior when the   * {@code poll()} methods differ only in their behavior when the
74   * queue is empty: the <tt>remove()</tt> method throws an exception,   * queue is empty: the {@code remove()} method throws an exception,
75   * while the <tt>poll()</tt> method returns <tt>null</tt>.   * while the {@code poll()} method returns {@code null}.
76   *   *
77   * <p>The {@link #element()} and {@link #peek()} methods return, but do   * <p>The {@link #element()} and {@link #peek()} methods return, but do
78   * not remove, the head of the queue.   * not remove, the head of the queue.
79   *   *
80   * <p>The <tt>Queue</tt> interface does not define the <i>blocking queue   * <p>The {@code Queue} interface does not define the <i>blocking queue
81   * methods</i>, which are common in concurrent programming.  These methods,   * methods</i>, which are common in concurrent programming.  These methods,
82   * which wait for elements to appear or for space to become available, are   * which wait for elements to appear or for space to become available, are
83   * defined in the {@link java.util.concurrent.BlockingQueue} interface, which   * defined in the {@link java.util.concurrent.BlockingQueue} interface, which
84   * extends this interface.   * extends this interface.
85   *   *
86   * <p><tt>Queue</tt> implementations generally do not allow insertion   * <p>{@code Queue} implementations generally do not allow insertion
87   * of <tt>null</tt> elements, although some implementations, such as   * of {@code null} elements, although some implementations, such as
88   * {@link LinkedList}, do not prohibit insertion of <tt>null</tt>.   * {@link LinkedList}, do not prohibit insertion of {@code null}.
89   * Even in the implementations that permit it, <tt>null</tt> should   * Even in the implementations that permit it, {@code null} should
90   * not be inserted into a <tt>Queue</tt>, as <tt>null</tt> is also   * not be inserted into a {@code Queue}, as {@code null} is also
91   * used as a special return value by the <tt>poll</tt> method to   * used as a special return value by the {@code poll} method to
92   * indicate that the queue contains no elements.   * indicate that the queue contains no elements.
93   *   *
94   * <p><tt>Queue</tt> implementations generally do not define   * <p>{@code Queue} implementations generally do not define
95   * element-based versions of methods <tt>equals</tt> and   * element-based versions of methods {@code equals} and
96   * <tt>hashCode</tt> but instead inherit the identity based versions   * {@code hashCode} but instead inherit the identity based versions
97   * from class <tt>Object</tt>, because element-based equality is not   * from class {@code Object}, because element-based equality is not
98   * always well-defined for queues with the same elements but different   * always well-defined for queues with the same elements but different
99   * ordering properties.   * ordering properties.
100   *   *
  *  
101   * <p>This interface is a member of the   * <p>This interface is a member of the
102   * <a href="{@docRoot}/../guide/collections/index.html">   * <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
103   * Java Collections Framework</a>.   * Java Collections Framework</a>.
104   *   *
  * @see java.util.Collection  
  * @see LinkedList  
  * @see PriorityQueue  
  * @see java.util.concurrent.LinkedBlockingQueue  
  * @see java.util.concurrent.BlockingQueue  
  * @see java.util.concurrent.ArrayBlockingQueue  
  * @see java.util.concurrent.LinkedBlockingQueue  
  * @see java.util.concurrent.PriorityBlockingQueue  
105   * @since 1.5   * @since 1.5
106   * @author Doug Lea   * @author Doug Lea
107   * @param <E> the type of elements held in this collection   * @param <E> the type of elements held in this queue
108   */   */
109  public interface Queue<E> extends Collection<E> {  public interface Queue<E> extends Collection<E> {
110      /**      /**
111       * Inserts the specified element into this queue if it is possible to do so       * Inserts the specified element into this queue if it is possible to do so
112       * immediately without violating capacity restrictions, returning       * immediately without violating capacity restrictions, returning
113       * <tt>true</tt> upon success and throwing an <tt>IllegalStateException</tt>       * {@code true} upon success and throwing an {@code IllegalStateException}
114       * if no space is currently available.       * if no space is currently available.
115       *       *
116       * @param e the element to add       * @param e the element to add
117       * @return <tt>true</tt> (as per the spec for {@link Collection#add})       * @return {@code true} (as specified by {@link Collection#add})
118       * @throws IllegalStateException if the element cannot be added at this       * @throws IllegalStateException if the element cannot be added at this
119       *         time due to capacity restrictions       *         time due to capacity restrictions
      * @throws NullPointerException if the specified element is null and  
      *         this queue not permit null elements  
120       * @throws ClassCastException if the class of the specified element       * @throws ClassCastException if the class of the specified element
121       *         prevents it from being added to this queue       *         prevents it from being added to this queue
122         * @throws NullPointerException if the specified element is null and
123         *         this queue does not permit null elements
124       * @throws IllegalArgumentException if some property of this element       * @throws IllegalArgumentException if some property of this element
125       *         prevents it from being added to this queue       *         prevents it from being added to this queue
126       */       */
# Line 135  Line 129 
129      /**      /**
130       * Inserts the specified element into this queue if it is possible to do       * Inserts the specified element into this queue if it is possible to do
131       * so immediately without violating capacity restrictions.       * so immediately without violating capacity restrictions.
132       * When using a capacity-restricted deque, this method is generally       * When using a capacity-restricted queue, this method is generally
133       * preferable to {@link #add}, which can fail to insert an element only       * preferable to {@link #add}, which can fail to insert an element only
134       * by throwing an exception.       * by throwing an exception.
135       *       *
136       * @param e the element to add       * @param e the element to add
137       * @return <tt>true</tt> if the element was added to this queue, else       * @return {@code true} if the element was added to this queue, else
138       *         <tt>false</tt>       *         {@code false}
      * @throws NullPointerException if the specified element is null and  
      *         this queue does not permit null elements  
139       * @throws ClassCastException if the class of the specified element       * @throws ClassCastException if the class of the specified element
140       *         prevents it from being added to this queue       *         prevents it from being added to this queue
141         * @throws NullPointerException if the specified element is null and
142         *         this queue does not permit null elements
143       * @throws IllegalArgumentException if some property of this element       * @throws IllegalArgumentException if some property of this element
144       *         prevents it from being added to this queue       *         prevents it from being added to this queue
145       */       */
# Line 153  Line 147 
147    
148      /**      /**
149       * Retrieves and removes the head of this queue.  This method differs       * Retrieves and removes the head of this queue.  This method differs
150       * from {@link #poll} only in that it throws an exception if this queue       * from {@link #poll() poll()} only in that it throws an exception if
151       * is empty.       * this queue is empty.
152       *       *
153       * @return the head of this queue       * @return the head of this queue
154       * @throws NoSuchElementException if this queue is empty       * @throws NoSuchElementException if this queue is empty
# Line 163  Line 157 
157    
158      /**      /**
159       * Retrieves and removes the head of this queue,       * Retrieves and removes the head of this queue,
160       * or returns <tt>null</tt> if this queue is empty.       * or returns {@code null} if this queue is empty.
161       *       *
162       * @return the head of this queue, or <tt>null</tt> if this queue is empty       * @return the head of this queue, or {@code null} if this queue is empty
163       */       */
164      E poll();      E poll();
165    
166      /**      /**
167       * Retrieves, but does not remove, the head of this queue.  This method       * Retrieves, but does not remove, the head of this queue.  This method
168       * differs from {@link #peek} only in that it throws an exception if       * differs from {@link #peek peek} only in that it throws an exception
169       * this queue is empty.       * if this queue is empty.
170       *       *
171       * @return the head of this queue       * @return the head of this queue
172       * @throws NoSuchElementException if this queue is empty       * @throws NoSuchElementException if this queue is empty
# Line 181  Line 175 
175    
176      /**      /**
177       * Retrieves, but does not remove, the head of this queue,       * Retrieves, but does not remove, the head of this queue,
178       * or returns <tt>null</tt> if this queue is empty.       * or returns {@code null} if this queue is empty.
179       *       *
180       * @return the head of this queue, or <tt>null</tt> if this queue is empty       * @return the head of this queue, or {@code null} if this queue is empty
181       */       */
182      E peek();      E peek();
183  }  }

Legend:
Removed from v.1.29  
changed lines
  Added in v.1.50

Doug Lea
ViewVC Help
Powered by ViewVC 1.0.8