[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.7, Tue Jun 24 14:34:30 2003 UTC revision 1.40, Sat Jul 20 18:00:11 2013 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. Use, modify, and   * Expert Group and released to the public domain, as explained at
4   * redistribute this code in any way without acknowledgement.   * 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 Collection} operations, queues provide   * Besides basic {@link java.util.Collection Collection} operations,
12   * additional insertion, extraction, and inspection operations.   * queues provide additional insertion, extraction, and inspection
13  0 *   * operations.  Each of these methods exists in two forms: one throws
14     * an exception if the operation fails, the other returns a special
15     * value (either {@code null} or {@code false}, depending on the
16     * operation).  The latter form of the insert operation is designed
17     * specifically for use with capacity-restricted {@code Queue}
18     * implementations; in most implementations, insert operations cannot
19     * fail.
20     *
21     * <p>
22     * <table BORDER CELLPADDING=3 CELLSPACING=1>
23     * <caption>Summary of Queue methods</caption>
24     *  <tr>
25     *    <td></td>
26     *    <td ALIGN=CENTER><em>Throws exception</em></td>
27     *    <td ALIGN=CENTER><em>Returns special value</em></td>
28     *  </tr>
29     *  <tr>
30     *    <td><b>Insert</b></td>
31     *    <td>{@link Queue#add add(e)}</td>
32     *    <td>{@link Queue#offer offer(e)}</td>
33     *  </tr>
34     *  <tr>
35     *    <td><b>Remove</b></td>
36     *    <td>{@link Queue#remove remove()}</td>
37     *    <td>{@link Queue#poll poll()}</td>
38     *  </tr>
39     *  <tr>
40     *    <td><b>Examine</b></td>
41     *    <td>{@link Queue#element element()}</td>
42     *    <td>{@link Queue#peek peek()}</td>
43     *  </tr>
44     * </table>
45     *
46   * <p>Queues typically, but do not necessarily, order elements in a   * <p>Queues typically, but do not necessarily, order elements in a
47   * FIFO (first-in-first-out) manner.  Among the exceptions are   * FIFO (first-in-first-out) manner.  Among the exceptions are
48   * priority queues, which order elements according to a supplied   * priority queues, which order elements according to a supplied
49   * comparator, or the elements' natural ordering.  Every Queue   * comparator, or the elements' natural ordering, and LIFO queues (or
50   * implementation must specify its ordering guarantees.   * stacks) which order the elements LIFO (last-in-first-out).
51   *   * Whatever the ordering used, the <em>head</em> of the queue is that
52   * <p>The {@link #offer(E)} method adds an element if possible, otherwise   * element which would be removed by a call to {@link #remove() } or
53   * returning <tt>false</tt>.  This differs from the {@link   * {@link #poll()}.  In a FIFO queue, all new elements are inserted at
54   * Collections#add(Object)} method, which throws an unchecked exception upon   * the <em>tail</em> of the queue. Other kinds of queues may use
55   * failure. It is designed for use in collections in which failure to   * different placement rules.  Every {@code Queue} implementation
56   * add is a normal, rather than exceptional occurrence, for example,   * must specify its ordering properties.
57   * in fixed-capacity (or &ldquo;bounded&rdquo;) queues.   *
58     * <p>The {@link #offer offer} method inserts an element if possible,
59     * otherwise returning {@code false}.  This differs from the {@link
60     * java.util.Collection#add Collection.add} method, which can fail to
61     * add an element only by throwing an unchecked exception.  The
62     * {@code offer} method is designed for use when failure is a normal,
63     * rather than exceptional occurrence, for example, in fixed-capacity
64     * (or &quot;bounded&quot;) queues.
65   *   *
66   * <p>The {@link #remove()} and {@link #poll()} methods remove and   * <p>The {@link #remove()} and {@link #poll()} methods remove and
67   * return an element in accord with the implementation's ordering   * return the head of the queue.
68   * policy.  Exactly which element is removed from the queue is a   * Exactly which element is removed from the queue is a
69   * function of the queue's ordering policy, which differs from   * function of the queue's ordering policy, which differs from
70   * implementation to implementation.  Possible orderings include (but   * implementation to implementation. The {@code remove()} and
71   * are not limited to) first-in-first-out (FIFO), last-in-first-out   * {@code poll()} methods differ only in their behavior when the
72   * (LIFO), element priority, and arbitrary.  The <tt>remove()</tt> and   * queue is empty: the {@code remove()} method throws an exception,
73   * <tt>poll()</tt> methods differ only in their behavior when the   * while the {@code poll()} method returns {@code null}.
74   * queue is empty: the <tt>remove()</tt> method throws an exception,   *
75   * while the <tt>poll()</tt> method returns <tt>null</tt>.   * <p>The {@link #element()} and {@link #peek()} methods return, but do
76   *   * not remove, the head of the queue.
  * <p>The {@link #element()} and {@link #peek()} methods return but do  
  * not delete the element that would be obtained by a call to  
  * the <tt>remove</tt> and <tt>poll</tt> methods respectively.  
77   *   *
78   * <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
79   * methods</i>, which are common in concurrent programming.  These methods,   * methods</i>, which are common in concurrent programming.  These methods,
80   * 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
81   * defined in the {@link java.util.concurrent.BlockingQueue} interface, which   * defined in the {@link java.util.concurrent.BlockingQueue} interface, which
82   * extends this interface.   * extends this interface.
83   *   *
84   * <p><tt>Queue</tt> implementations generally do not allow insertion   * <p>{@code Queue} implementations generally do not allow insertion
85   * of <tt>null</tt> elements, although some implementations, such as   * of {@code null} elements, although some implementations, such as
86   * {@link LinkedList}, do not prohibit insertion of <tt>null</tt>.   * {@link LinkedList}, do not prohibit insertion of {@code null}.
87   * Even in the implementations that permit it, <tt>null</tt> should   * Even in the implementations that permit it, {@code null} should
88   * 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
89   * 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
90   * indicate that the queue contains no elements.   * indicate that the queue contains no elements.
91   *   *
92     * <p>{@code Queue} implementations generally do not define
93     * element-based versions of methods {@code equals} and
94     * {@code hashCode} but instead inherit the identity based versions
95     * from class {@code Object}, because element-based equality is not
96     * always well-defined for queues with the same elements but different
97     * ordering properties.
98     *
99     *
100   * <p>This interface is a member of the   * <p>This interface is a member of the
101   * <a href="{@docRoot}/../guide/collections/index.html">   * <a href="{@docRoot}/../technotes/guides/collections/index.html">
102   * Java Collections Framework</a>.   * Java Collections Framework</a>.
103   *   *
104   * @see Collection   * @see java.util.Collection
105   * @see LinkedList   * @see LinkedList
106   * @see PriorityQueue   * @see PriorityQueue
107   * @see java.util.concurrent.LinkedQueue   * @see java.util.concurrent.LinkedBlockingQueue
108   * @see java.util.concurrent.BlockingQueue   * @see java.util.concurrent.BlockingQueue
109   * @see java.util.concurrent.ArrayBlockingQueue   * @see java.util.concurrent.ArrayBlockingQueue
110   * @see java.util.concurrent.LinkedBlockingQueue   * @see java.util.concurrent.LinkedBlockingQueue
111   * @see java.util.concurrent.PriorityBlockingQueue   * @see java.util.concurrent.PriorityBlockingQueue
112   * @since 1.5   * @since 1.5
113   * @author Doug Lea   * @author Doug Lea
114     * @param <E> the type of elements held in this collection
115   */   */
116  public interface Queue<E> extends Collection<E> {  public interface Queue<E> extends Collection<E> {
117      /**      /**
118       * Add the specified element to this queue, if possible.       * Inserts the specified element into this queue if it is possible to do so
119       *       * immediately without violating capacity restrictions, returning
120       * @param element the element to add.       * {@code true} upon success and throwing an {@code IllegalStateException}
121       * @return true if it was possible to add the element to the queue.       * if no space is currently available.
122         *
123         * @param e the element to add
124         * @return {@code true} (as specified by {@link Collection#add})
125         * @throws IllegalStateException if the element cannot be added at this
126         *         time due to capacity restrictions
127         * @throws ClassCastException if the class of the specified element
128         *         prevents it from being added to this queue
129         * @throws NullPointerException if the specified element is null and
130         *         this queue does not permit null elements
131         * @throws IllegalArgumentException if some property of this element
132         *         prevents it from being added to this queue
133         */
134        boolean add(E e);
135    
136        /**
137         * Inserts the specified element into this queue if it is possible to do
138         * so immediately without violating capacity restrictions.
139         * When using a capacity-restricted queue, this method is generally
140         * preferable to {@link #add}, which can fail to insert an element only
141         * by throwing an exception.
142         *
143         * @param e the element to add
144         * @return {@code true} if the element was added to this queue, else
145         *         {@code false}
146         * @throws ClassCastException if the class of the specified element
147         *         prevents it from being added to this queue
148         * @throws NullPointerException if the specified element is null and
149         *         this queue does not permit null elements
150         * @throws IllegalArgumentException if some property of this element
151         *         prevents it from being added to this queue
152       */       */
153      boolean offer(E element);      boolean offer(E e);
154    
155      /**      /**
156       * Remove and return an element from the queue if one is available.       * Retrieves and removes the head of this queue.  This method differs
157       *       * from {@link #poll poll} only in that it throws an exception if this
      * @return an element previously on the queue, or <tt>null</tt> if the  
158       *         queue is empty.       *         queue is empty.
159         *
160         * @return the head of this queue
161         * @throws NoSuchElementException if this queue is empty
162       */       */
163      E poll();      E remove();
164    
165      /**      /**
166       * Remove and return an element from the queue.  This method differs       * Retrieves and removes the head of this queue,
167       * from the <tt>poll</tt> method in that it throws an exception if the       * or returns {@code null} if this queue is empty.
      * queue is empty.  
168       *       *
169       * @return an element previously on the queue.       * @return the head of this queue, or {@code null} if this queue is empty
      * @throws NoSuchElementException if the queue is empty.  
170       */       */
171      E remove() throws NoSuchElementException;      E poll();
172    
173      /**      /**
174       * Return, but do not remove, an element from the queue, or <tt>null</tt>       * Retrieves, but does not remove, the head of this queue.  This method
175       * if the queue is empty.  This method returns the same object reference       * differs from {@link #peek peek} only in that it throws an exception
176       * that would be returned by by the <tt>poll</tt> method.  The two methods       * if this queue is empty.
      * differ in that this method does not remove the element from the queue.  
177       *       *
178       * @return an element on the queue, or <tt>null</tt> if the queue is empty.       * @return the head of this queue
179         * @throws NoSuchElementException if this queue is empty
180       */       */
181      E peek();      E element();
182    
183      /**      /**
184       * Return, but do not remove, an element from the queue.  This method       * Retrieves, but does not remove, the head of this queue,
185       * differs from the <tt>peek</tt> method in that it throws an exception if       * or returns {@code null} if this queue is empty.
      * the queue is empty.  
186       *       *
187       * @return an element on the queue.       * @return the head of this queue, or {@code null} if this queue is empty
      * @throws NoSuchElementException if the queue is empty.  
188       */       */
189      E element() throws NoSuchElementException;      E peek();
190  }  }

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.40

Doug Lea
ViewVC Help
Powered by ViewVC 1.0.8