Home » openjdk-7 » java » util » [javadoc | source]
abstract public class: AbstractQueue [javadoc | source]

All Implemented Interfaces:
    Queue, Collection

Direct Known Subclasses:
    SynchronousQueue, AsLIFOQueue, PriorityQueue, PriorityBlockingQueue, LinkedBlockingQueue, DelayedWorkQueue, LinkedTransferQueue, ConcurrentLinkedQueue, ArrayBlockingQueue, LinkedBlockingDeque, DelayQueue

This class provides skeletal implementations of some Queue operations. The implementations in this class are appropriate when the base implementation does not allow null elements. Methods add , remove , and element are based on offer , poll , and peek , respectively, but throw exceptions instead of indicating failure via false or null returns.

A Queue implementation that extends this class must minimally define a method Queue#offer which does not permit insertion of null elements, along with methods Queue#peek , Queue#poll , Collection#size , and Collection#iterator . Typically, additional methods will be overridden as well. If these requirements cannot be met, consider instead subclassing AbstractCollection .

This class is a member of the Java Collections Framework.

 protected AbstractQueue() 
Method from java.util.AbstractQueue Summary:
add,   addAll,   clear,   element,   remove
Methods from java.util.AbstractCollection:
add,   addAll,   clear,   contains,   containsAll,   isEmpty,   iterator,   remove,   removeAll,   retainAll,   size,   toArray,   toArray,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.AbstractQueue Detail:
 public boolean add(E e) 
    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.

    This implementation returns true if offer succeeds, else throws an IllegalStateException.

 public boolean addAll(Collection<? extends E> c) 
    Adds all of the elements in the specified collection to this queue. Attempts to addAll of a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

    This implementation iterates over the specified collection, and adds each element returned by the iterator to this queue, in turn. A runtime exception encountered while trying to add an element (including, in particular, a null element) may result in only some of the elements having been successfully added when the associated exception is thrown.

 public  void clear() 
    Removes all of the elements from this queue. The queue will be empty after this call returns.

    This implementation repeatedly invokes poll until it returns null.

 public E element() 
    Retrieves, but does not remove, the head of this queue. This method differs from peek only in that it throws an exception if this queue is empty.

    This implementation returns the result of peek unless the queue is empty.

 public E remove() 
    Retrieves and removes the head of this queue. This method differs from poll only in that it throws an exception if this queue is empty.

    This implementation returns the result of poll unless the queue is empty.