public class CircularFifoBuffer extends BoundedFifoBuffer
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)
, BoundedFifoBuffer.remove()
and BoundedFifoBuffer.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.
Constructor and Description |
---|
CircularFifoBuffer()
Constructor that creates a buffer with the default size of 32.
|
CircularFifoBuffer(Collection coll)
Constructor that creates a buffer from the specified collection.
|
CircularFifoBuffer(int size)
Constructor that creates a buffer with the specified size.
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(Object element)
If the buffer is full, the least recently added element is discarded so
that a new element can be inserted.
|
clear, get, isEmpty, isFull, iterator, maxSize, remove, size
addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString
public CircularFifoBuffer()
public CircularFifoBuffer(int size)
size
- the size of the buffer (cannot be changed)IllegalArgumentException
- if the size is less than 1public CircularFifoBuffer(Collection coll)
coll
- the collection to copy into the buffer, may not be nullNullPointerException
- if the collection is nullpublic boolean add(Object element)
add
in interface Collection
add
in class BoundedFifoBuffer
element
- the element to addCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.