Queue  |  API reference  |  Android Developers (original) (raw)

interface Queue<E : Any!> : MutableCollection

Known Indirect Subclasses

ArrayBlockingQueue, ArrayBlockingQueue, ArrayDeque, BlockingDeque, BlockingDeque, ConcurrentLinkedDeque, ConcurrentLinkedQueue, DelayQueue, DelayQueue, LinkedBlockingDeque, LinkedBlockingDeque, LinkedBlockingDeque, and 11 others.

A collection designed for holding elements prior to processing. Besides basic [Collection](/reference/kotlin/java/util/Collection) operations, queues provide additional insertion, extraction, and inspection operations. Each of these methods exists in two forms: one throws an exception if the operation fails, the other returns a special value (either null or false, depending on the operation). The latter form of the insert operation is designed specifically for use with capacity-restricted Queue implementations; in most implementations, insert operations cannot fail.

Summary of Queue methods

Queues typically, but do not necessarily, order elements in a FIFO (first-in-first-out) manner. Among the exceptions are priority queues, which order elements according to a supplied comparator, or the elements' natural ordering, and LIFO queues (or stacks) which order the elements LIFO (last-in-first-out). Whatever the ordering used, the head of the queue is that element which would be removed by a call to [remove()](#remove%28%29) or [poll()](#poll%28%29). In a FIFO queue, all new elements are inserted at the tail of the queue. Other kinds of queues may use different placement rules. Every Queue implementation must specify its ordering properties.

The [offer](#offer%28java.util.Queue.E%29) method inserts an element if possible, otherwise returning false. This differs from the [Collection.add](/reference/kotlin/java/util/Collection#add%28java.util.Collection.E%29) method, which can fail to add an element only by throwing an unchecked exception. The offer method is designed for use when failure is a normal, rather than exceptional occurrence, for example, in fixed-capacity (or "bounded") queues.

The [remove()](#remove%28%29) and [poll()](#poll%28%29) methods remove and return the head of the queue. Exactly which element is removed from the queue is a function of the queue's ordering policy, which differs from implementation to implementation. The remove() and poll() methods differ only in their behavior when the queue is empty: the remove() method throws an exception, while the poll() method returns null.

The [element()](#element%28%29) and [peek()](#peek%28%29) methods return, but do not remove, the head of the queue.

The Queue interface does not define the blocking queue methods, which are common in concurrent programming. These methods, which wait for elements to appear or for space to become available, are defined in the [java.util.concurrent.BlockingQueue](/reference/kotlin/java/util/concurrent/BlockingQueue) interface, which extends this interface.

Queue implementations generally do not allow insertion of null elements, although some implementations, such as [LinkedList](/reference/kotlin/java/util/LinkedList), do not prohibit insertion of null. Even in the implementations that permit it, null should not be inserted into a Queue, as null is also used as a special return value by the poll method to indicate that the queue contains no elements.

Queue implementations generally do not define element-based versions of methods equals and hashCode but instead inherit the identity based versions from class Object, because element-based equality is not always well-defined for queues with the same elements but different ordering properties.

Summary

Public methods

add

abstract fun add(element: E): Boolean

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.

element

abstract fun element(): E

Retrieves, but does not remove, the head of this queue. This method differs from [peek](#peek%28%29) only in that it throws an exception if this queue is empty.

offer

abstract fun offer(e: E): Boolean

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted queue, this method is generally preferable to [add](#add%28java.util.Queue.E%29), which can fail to insert an element only by throwing an exception.

peek

abstract fun peek(): E?

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

poll

abstract fun poll(): E?

Retrieves and removes the head of this queue, or returns null if this queue is empty.

remove

abstract fun remove(): E

Retrieves and removes the head of this queue. This method differs from [poll()](#poll%28%29) only in that it throws an exception if this queue is empty.