org.apache.commons.collections.buffer
Class BoundedFifoBuffer<E>

java.lang.Object
  java.util.AbstractCollection<E>
      org.apache.commons.collections.buffer.BoundedFifoBuffer<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, BoundedCollection<E>, Buffer<E>

Direct Known Subclasses:

CircularFifoBuffer

public class BoundedFifoBuffer<E>
extends AbstractCollection<E>
implements Buffer<E>, BoundedCollection<E>, Serializable

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.

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0 (previously in main package v2.1)

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:33:51 $

Author:

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

See Also:

Serialized Form

Constructor Summary

BoundedFifoBuffer()
Constructs a new BoundedFifoBuffer big enough to hold 32 elements.

BoundedFifoBuffer(Collection<E> coll)
Constructs a new BoundedFifoBuffer big enough to hold all of the elements in the specified collection.

BoundedFifoBuffer(int size)
Constructs a new BoundedFifoBuffer big enough to hold the specified number of elements.

Method Summary

boolean	add(E element) Adds the given element to this buffer.
void	clear() Clears this buffer.
E	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<E>	iterator() Returns an iterator over this buffer's elements.
int	maxSize() Gets the maximum size of the collection (the bound).
E	remove() Removes the least recently inserted element from this buffer.
int	size() Returns the number of elements stored in the buffer.

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

addAll, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

addAll, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray

Constructor Detail

BoundedFifoBuffer

public BoundedFifoBuffer()

Constructs a new BoundedFifoBuffer big enough to hold 32 elements.

BoundedFifoBuffer

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

BoundedFifoBuffer

public BoundedFifoBuffer(Collection<E> 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

Method Detail

size

public int size()

Returns the number of elements stored in the buffer.

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

Returns:

this buffer's size

isEmpty

public boolean isEmpty()

Returns true if this buffer is empty; false otherwise.

Specified by:

isEmpty in interface Collection<E>

Overrides:

isEmpty in class AbstractCollection<E>

Returns:

true if this buffer is empty

isFull

public boolean isFull()

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

Specified by:

isFull in interface BoundedCollection<E>

Returns:

true if the collection is full

maxSize

public int maxSize()

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

Specified by:

maxSize in interface BoundedCollection<E>

Returns:

the maximum number of elements the collection can hold

clear

public void clear()

Clears this buffer.

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>

add

public boolean add(E element)

Adds the given element to this buffer.

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

Parameters:

element - the element to add

Returns:

true, always

Throws:

NullPointerException - if the given element is null

BufferOverflowException - if this buffer is full

get

public E get()

Returns the least recently inserted element in this buffer.

Specified by:

get in interface Buffer<E>

Returns:

the least recently inserted element

Throws:

BufferUnderflowException - if the buffer is empty

remove

public E remove()

Removes the least recently inserted element from this buffer.

Specified by:

remove in interface Buffer<E>

Returns:

the least recently inserted element

Throws:

BufferUnderflowException - if the buffer is empty

iterator

public Iterator<E> iterator()

Returns an iterator over this buffer's elements.

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

an iterator over this buffer's elements