public class BoundedFifoBuffer extends java.util.AbstractCollection implements Buffer
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.
Constructor and Description |
---|
BoundedFifoBuffer()
Constructs a new
BoundedFifoBuffer big enough to hold
32 elements. |
BoundedFifoBuffer(java.util.Collection 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. |
Modifier and Type | Method and Description |
---|---|
boolean |
add(java.lang.Object element)
Adds the given element to this buffer.
|
void |
clear()
Clears this buffer.
|
java.lang.Object |
get()
Returns the least recently inserted element in this buffer.
|
boolean |
isEmpty()
Returns true if this buffer is empty; false otherwise.
|
java.util.Iterator |
iterator()
Returns an iterator over this buffer's elements.
|
java.lang.Object |
remove()
Removes the least recently inserted element from this buffer.
|
int |
size()
Returns the number of elements stored in the buffer.
|
addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString
public BoundedFifoBuffer()
BoundedFifoBuffer
big enough to hold
32 elements.public BoundedFifoBuffer(java.util.Collection coll)
BoundedFifoBuffer
big enough to hold all
of the elements in the specified collection. That collection's
elements will also be added to the buffer.coll
- the collection whose elements to addpublic BoundedFifoBuffer(int size)
BoundedFifoBuffer
big enough to hold
the specified number of elements.size
- the maximum number of elements for this fifojava.lang.IllegalArgumentException
- if the size is less than 1public boolean add(java.lang.Object element)
add
in interface java.util.Collection
add
in class java.util.AbstractCollection
element
- the element to addjava.lang.NullPointerException
- if the given element is nullBufferOverflowException
- if this buffer is fullpublic void clear()
clear
in interface java.util.Collection
clear
in class java.util.AbstractCollection
public java.lang.Object get()
get
in interface Buffer
BufferUnderflowException
- if the buffer is emptypublic boolean isEmpty()
isEmpty
in interface java.util.Collection
isEmpty
in class java.util.AbstractCollection
public java.util.Iterator iterator()
iterator
in interface java.lang.Iterable
iterator
in interface java.util.Collection
iterator
in class java.util.AbstractCollection
public java.lang.Object remove()
remove
in interface Buffer
BufferUnderflowException
- if the buffer is emptypublic int size()
size
in interface java.util.Collection
size
in class java.util.AbstractCollection
Copyright © 2001-2004 Apache Software Foundation. Documenation generated September 19 2012.