Android
java.util
public interface

java.util.Queue<E>

java.util.Queue<E> Collection<E>

A kind of collection provides advanced operations than other basic collections, such as insertion, extraction, and inspection. Generally, a queue orders its elements by means of first-in-first-out. While priority queue orders its elements according to a comparator specified or the elements' natural order. Furthermore, a stack orders its elements last-in-first out. A typical queue does not allow null to be inserted as its element, while some implementations such as LinkedList allow it. But null should not be inserted even in these implementations, since method poll return null to indicate that there is no element left in the queue. Queue does not provide blocking queue methods, which will block until the operation of the method is allowed. BlockingQueue interface defines such methods.

Known Indirect Subclasses

Summary

Public Methods

          element()
Gets but not removes the element in the head of the queue.
          boolean  offer(E o)
Inserts the specified element into the queue provided that the condition allows such an operation.
          peek()
Gets but not removes the element in the head of the queue, or throws exception if there is no element in the queue.
          poll()
Gets and removes the element in the head of the queue, or returns null if there is no element in the queue.
          remove()
Gets and removes the element in the head of the queue.
Methods inherited from interface java.lang.Iterable
Methods inherited from interface java.util.Collection

Details

Public Methods

public E element()

Gets but not removes the element in the head of the queue. Throws a NoSuchElementException if there is no element in the queue.

Returns

  • the element in the head of the queue.

Throws

NoSuchElementException if there is no element in the queue.

public boolean offer(E o)

Inserts the specified element into the queue provided that the condition allows such an operation. The method is generally preferable to the collection.add(E), since the latter might throw an exception if the operation fails.

Parameters

o the specified element to insert into the queue.

Returns

  • true if the operation succeeds and false if it fails.

public E peek()

Gets but not removes the element in the head of the queue, or throws exception if there is no element in the queue.

Returns

  • the element in the head of the queue or null if there is no element in the queue.

public E poll()

Gets and removes the element in the head of the queue, or returns null if there is no element in the queue.

Returns

  • the element in the head of the queue or null if there is no element in the queue.

public E remove()

Gets and removes the element in the head of the queue. Throws a NoSuchElementException if there is no element in the queue.

Returns

  • the element in the head of the queue.

Throws

NoSuchElementException if there is no element in the queue.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48