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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.49 - (view) (download)

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

Doug Lea
ViewVC Help
Powered by ViewVC 1.0.8