org.apache.commons.collections.buffer
Class UnboundedFifoBuffer
AbstractCollection
org.apache.commons.collections.buffer.UnboundedFifoBuffer
- Buffer, Collection, Serializable
public class UnboundedFifoBuffer
extends AbstractCollection
implements Buffer, Serializable
UnboundedFifoBuffer is a very efficient buffer implementation.
According to performance testing, it exhibits a constant access time, but it
also outperforms ArrayList when used for the same purpose.
The removal order of an
UnboundedFifoBuffer
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
remove()
and
get()
operations perform in constant time.
The
add(Object)
operation performs in amortized 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
UnboundedFifoBuffer
:
Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifoBuffer());
This buffer prevents null objects from being added.
This class is Serializable from Commons Collections 3.1.
$Revision: 1.9 $ $Date: 2004/06/01 22:57:18 $- Avalon
- Federico Barbieri
- Berin Loritsch
- Paul Jack
- Stephen Colebourne
- Commons Collections 3.0 (previously in main package v2.1)
protected Object[] | buffer - The array of objects in the buffer.
|
protected int | head - The current head index.
|
protected int | tail - The current tail index.
|
UnboundedFifoBuffer() - Constructs an UnboundedFifoBuffer with the default number of elements.
|
UnboundedFifoBuffer(int initialSize) - Constructs an UnboundedFifoBuffer with the specified number of elements.
|
boolean | add(Object obj) - Adds the given element to this buffer.
|
Object | get() - Returns the next object in the buffer.
|
boolean | isEmpty() - Returns true if this buffer is empty; false otherwise.
|
Iterator | iterator() - Returns an iterator over this buffer's elements.
|
Object | remove() - Removes the next object from the buffer
|
int | size() - Returns the number of elements stored in the buffer.
|
buffer
protected Object[] buffer
The array of objects in the buffer.
head
protected int head
The current head index.
tail
protected int tail
The current tail index.
UnboundedFifoBuffer
public UnboundedFifoBuffer()
Constructs an UnboundedFifoBuffer with the default number of elements.
It is exactly the same as performing the following:
new UnboundedFifoBuffer(32);
UnboundedFifoBuffer
public UnboundedFifoBuffer(int initialSize)
Constructs an UnboundedFifoBuffer with the specified number of elements.
The integer must be a positive integer.
initialSize
- the initial size of the buffer
add
public boolean add(Object obj)
Adds the given element to this buffer.
get
public Object get()
Returns the next object in the buffer.
- get in interface Buffer
- the next object in the buffer
isEmpty
public boolean isEmpty()
Returns true if this buffer is empty; false otherwise.
- true if this buffer is empty
iterator
public Iterator iterator()
Returns an iterator over this buffer's elements.
- an iterator over this buffer's elements
remove
public Object remove()
Removes the next object from the buffer
- remove in interface Buffer
size
public int size()
Returns the number of elements stored in the buffer.
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.