org.apache.commons.collections

Interface Buffer

public interface Buffer extends Collection

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

Since: Commons Collections 2.1

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Avalon Berin Loritsch Paul Jack Stephen Colebourne

Method Summary
Objectget()
Gets the next object from the buffer without removing it.
Objectremove()
Gets and removes the next object from the buffer.

Method Detail

get

public Object 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

remove

public Object 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

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.