public interface

Buffer

implements Collection<E>
org.apache.commons.collections.Buffer
Known Indirect Subclasses

Class Overview

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 equals(Object) and hashCode() methods. It is therefore possible for a Buffer implementation to also also implement List, Set or Bag.

Summary

Public Methods
abstract Object get()
Gets the next object from the buffer without removing it.
abstract Object remove()
Gets and removes the next object from the buffer.
[Expand]
Inherited Methods
From interface java.lang.Iterable
From interface java.util.Collection

Public Methods

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

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