org.apache.commons.collections

Interface Buffer

All Superinterfaces:
Collection
Known Implementing Classes:
ArrayStack, BinaryHeap, BoundedFifoBuffer, UnboundedFifoBuffer

public interface Buffer
extends Collection

A Buffer is 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 java.util.List, java.util.Set or Bag.

Version:
$Id: Buffer.java,v 1.3.2.1 2004/05/22 12:14:01 scolebourne Exp $
Authors:
Avalon
Berin Loritsch
Paul Jack
Stephen Colebourne
Since:
2.1

Method Summary

Object
get()
Returns the next object in the buffer without removing it.
Object
remove()
Removes the next object from the buffer.

Method Details

get

public Object get()
Returns the next object in the buffer without removing it.
Returns:
the next object in the buffer

remove

public Object remove()
Removes the next object from the buffer.
Returns:
the removed object

Copyright © 2001-2004 Apache Software Foundation. Documenation generated ${TODAY}.