org.apache.commons.collections
Class BoundedFifoBuffer
AbstractCollection
org.apache.commons.collections.BoundedFifoBuffer
- BoundedCollection, Buffer, Collection
public class BoundedFifoBuffer
extends AbstractCollection
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.
$Revision: 1.16 $ $Date: 2004/02/18 01:15:43 $- Avalon
- Berin Loritsch
- Paul Jack
- Stephen Colebourne
- Herve Quiroz
BoundedFifoBuffer() - Constructs a new
BoundedFifoBuffer big enough to hold
32 elements.
|
BoundedFifoBuffer(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.
|
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.
|
BoundedFifoBuffer
public BoundedFifoBuffer()
Constructs a new BoundedFifoBuffer
big enough to hold
32 elements.
BoundedFifoBuffer
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.
coll
- the collection whose elements to add, may not be null
BoundedFifoBuffer
public BoundedFifoBuffer(int size)
Constructs a new BoundedFifoBuffer
big enough to hold
the specified number of elements.
size
- the maximum number of elements for this fifo
add
public boolean add(Object element)
Adds the given element to this buffer.
element
- the element to add
clear
public void clear()
Clears this buffer.
get
public Object get()
Returns the least recently inserted element in this buffer.
- get in interface Buffer
- the least recently inserted element
isEmpty
public boolean isEmpty()
Returns true if this buffer is empty; false otherwise.
- true if this buffer is empty
isFull
public boolean isFull()
Returns true if this collection is full and no new elements can be added.
- isFull in interface BoundedCollection
true
if the collection is full
iterator
public Iterator iterator()
Returns an iterator over this buffer's elements.
- an iterator over this buffer's elements
maxSize
public int maxSize()
Gets the maximum size of the collection (the bound).
- maxSize in interface BoundedCollection
- the maximum number of elements the collection can hold
remove
public Object remove()
Removes the least recently inserted element from this buffer.
- remove in interface Buffer
- the least recently inserted element
size
public int size()
Returns the number of elements stored in the buffer.
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.