CircularFifoBuffer

Class Overview

CircularFifoBuffer is a first in first out buffer with a fixed size that replaces its oldest element if full.

The removal order of a CircularFifoBuffer 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 CircularFifoBuffer:

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

This buffer prevents null objects from being added.

This class is Serializable from Commons Collections 3.1.

Summary

[Expand] Inherited Methods
From class org.apache.commons.collections.buffer.BoundedFifoBuffer 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.
From class java.util.AbstractCollection boolean add(E arg0) boolean addAll(Collection<? extends E> arg0) void clear() boolean contains(Object arg0) boolean containsAll(Collection<?> arg0) boolean isEmpty() abstract Iterator<E> iterator() boolean remove(Object arg0) boolean removeAll(Collection<?> arg0) boolean retainAll(Collection<?> arg0) abstract int size() <T> T[] toArray(T[] arg0) Object[] toArray() String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface java.lang.Iterable abstract Iterator<T> iterator()
From interface java.util.Collection abstract boolean add(E arg0) abstract boolean addAll(Collection<? extends E> arg0) abstract void clear() abstract boolean contains(Object arg0) abstract boolean containsAll(Collection<?> arg0) abstract boolean equals(Object arg0) abstract int hashCode() abstract boolean isEmpty() abstract Iterator<E> iterator() abstract boolean remove(Object arg0) abstract boolean removeAll(Collection<?> arg0) abstract boolean retainAll(Collection<?> arg0) abstract int size() abstract <T> T[] toArray(T[] arg0) abstract Object[] toArray()
From interface org.apache.commons.collections.BoundedCollection abstract boolean isFull() Returns true if this collection is full and no new elements can be added. abstract int maxSize() Gets the maximum size of the collection (the bound).
From interface org.apache.commons.collections.Buffer 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.