public class

BoundedFifoBuffer

extends AbstractCollection<E>
implements BoundedCollection Buffer
java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ org.apache.commons.collections.BoundedFifoBuffer

This class is deprecated.
Moved to buffer subpackage. Due to be removed in v4.0.

Class Overview

The BoundedFifoBuffer is a very efficient implementation of Buffer that does not alter the size of the buffer at runtime.

The removal order of a BoundedFifoBuffer is based on the insertion order; elements are removed in the same order in which they were added. The iteration order is the same as the removal order.

The add(Object), remove() and get() operations all perform in constant time. All other operations perform in linear time or worse.

Note that this implementation is not synchronized. The following can be used to provide synchronized access to your BoundedFifoBuffer: 

   Buffer fifo = BufferUtils.synchronizedBuffer(new BoundedFifoBuffer());

This buffer prevents null objects from being added.

Summary

Public Constructors
BoundedFifoBuffer()
Constructs a new BoundedFifoBuffer big enough to hold 32 elements.
BoundedFifoBuffer(int size)
Constructs a new BoundedFifoBuffer big enough to hold the specified number of elements.
BoundedFifoBuffer(Collection coll)
Constructs a new BoundedFifoBuffer big enough to hold all of the elements in the specified collection.
Public Methods
boolean add(Object element)
Adds the given element to this buffer.
void clear()
Clears this buffer.
Object get()
Returns the least recently inserted element in this buffer.
boolean isEmpty()
Returns true if this buffer is empty; false otherwise.
boolean isFull()
Returns true if this collection is full and no new elements can be added.
Iterator iterator()
Returns an iterator over this buffer's elements.
int maxSize()
Gets the maximum size of the collection (the bound).
Object remove()
Removes the least recently inserted element from this buffer.
int size()
Returns the number of elements stored in the buffer.
[Expand]
Inherited Methods
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface org.apache.commons.collections.BoundedCollection
From interface org.apache.commons.collections.Buffer

Public Constructors

public BoundedFifoBuffer ()

Constructs a new BoundedFifoBuffer big enough to hold 32 elements.

public BoundedFifoBuffer (int size)

Constructs a new BoundedFifoBuffer big enough to hold the specified number of elements.

Parameters
size the maximum number of elements for this fifo
Throws
IllegalArgumentException if the size is less than 1

public BoundedFifoBuffer (Collection coll)

Constructs a new BoundedFifoBuffer big enough to hold all of the elements in the specified collection. That collection's elements will also be added to the buffer.

Parameters
coll the collection whose elements to add, may not be null
Throws
NullPointerException if the collection is null

Public Methods

public boolean add (Object element)

Adds the given element to this buffer.

Parameters
element the element to add
Returns
  • true, always
Throws
NullPointerException if the given element is null
BufferOverflowException if this buffer is full

public void clear ()

Clears this buffer.

public Object get ()

Returns the least recently inserted element in this buffer.

Returns
  • the least recently inserted element
Throws
BufferUnderflowException if the buffer is empty

public boolean isEmpty ()

Returns true if this buffer is empty; false otherwise.

Returns
  • true if this buffer is empty

public boolean isFull ()

Returns true if this collection is full and no new elements can be added.

Returns
  • true if the collection is full

public Iterator iterator ()

Returns an iterator over this buffer's elements.

Returns
  • an iterator over this buffer's elements

public int maxSize ()

Gets the maximum size of the collection (the bound).

Returns
  • the maximum number of elements the collection can hold

public Object remove ()

Removes the least recently inserted element from this buffer.

Returns
  • the least recently inserted element
Throws
BufferUnderflowException if the buffer is empty

public int size ()

Returns the number of elements stored in the buffer.

Returns
  • this buffer's size