org.apache.commons.collections
Interface Buffer<E>

All Superinterfaces:

Collection<E>, Iterable<E>

All Known Implementing Classes:

AbstractBufferDecorator, ArrayStack, BlockingBuffer, BoundedFifoBuffer, CircularFifoBuffer, PredicatedBuffer, PriorityBuffer, SynchronizedBuffer, TransformedBuffer, UnboundedFifoBuffer, UnmodifiableBuffer

public interface Buffer<E>
extends Collection<E>

Defines a collection that allows objects to be removed in some well-defined order.

The removal order can be based on insertion order (eg, a FIFO queue or a LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator (eg, a priority queue) or on any other well-defined ordering.

Note that the removal order is not necessarily the same as the iteration order. A Buffer implementation may have equivalent removal and iteration orders, but this is not required.

This interface does not specify any behavior for Object.equals(Object) and Object.hashCode() methods. It is therefore possible for a Buffer implementation to also also implement List, Set or Bag.

Since:

Commons Collections 2.1

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:32:40 $

Author:

Avalon, Berin Loritsch, Paul Jack, Matt Hall, John Watkinson, Stephen Colebourne

Method Summary

E	get() Gets the next object from the buffer without removing it.
E	remove() Gets and removes the next object from the buffer.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

remove

E remove()

Gets and removes the next object from the buffer.

Returns:

the next object in the buffer, which is also removed

Throws:

BufferUnderflowException - if the buffer is already empty

get

E get()

Gets the next object from the buffer without removing it.

Returns:

the next object in the buffer, which is not removed

Throws:

BufferUnderflowException - if the buffer is empty