[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.23, Sun Nov 21 01:40:39 2004 UTC revision 1.24, Sun Dec 26 20:13:57 2004 UTC
# Line 8  Line 8 
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, queues provide   * Besides basic {@link java.util.Collection Collection} operations,
12   * additional insertion, extraction, and inspection operations. The names   * queues provide additional insertion, extraction, and inspection
13   * of the operations vary with their policies:   * 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 <tt>null</tt> or <tt>false</tt>, depending on the
16     * operation).  The latter form of the insert operation is designed
17     * specifically for use with capacity-restricted <tt>Queue</tt>
18     * implementations; in most implementations, insert operations cannot
19     * fail.
20   *   *
21   *<table BORDER CELLPADDING=3 CELLSPACING=1>   *<table BORDER CELLPADDING=3 CELLSPACING=1>
22   *  <tr>   *  <tr>
23   *    <td><em>Operation</em></td>   *    <td></td>
24   *    <td ALIGN=CENTER><em>Attempt</em></td>   *    <td ALIGN=CENTER><em>Throws exception</em></td>
25   *    <td ALIGN=CENTER><em>Throw</em></td>   *    <td ALIGN=CENTER><em>Returns special value</em></td>
26   *  </tr>   *  </tr>
27   *  <tr>   *  <tr>
28   *    <td><em>insert</em></td>   *    <td><b>Insert</b></td>
29   *    <td>offer(x)</td>   *    <td>{@link #add add(e)}</td>
30   *    <td>add(x)</td>   *    <td>{@link #offer offer(e)}</td>
31   *  </tr>   *  </tr>
32   *  <tr>   *  <tr>
33   *    <td><em>extract</em></td>   *    <td><b>Remove</b></td>
34   *    <td>poll()</td>   *    <td>{@link #remove remove()}</td>
35   *    <td>remove()</td>   *    <td>{@link #poll poll()}</td>
36   *  </tr>   *  </tr>
37   *  <tr>   *  <tr>
38   *    <td><em>inspect</em></td>   *    <td><b>Examine</b></td>
39   *    <td>peek()</td>   *    <td>{@link #element element()}</td>
40   *    <td>element()</td>   *    <td>{@link #peek peek()}</td>
41   *  </tr>   *  </tr>
42   *</table>   *</table>
43   *   *

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.24

Doug Lea
ViewVC Help
Powered by ViewVC 1.0.8