java.lang.Object | ||
↳ | java.util.AbstractCollection<E> | |
↳ | org.apache.commons.collections.UnboundedFifoBuffer |
This class is deprecated.
Moved to buffer subpackage. Due to be removed in v4.0.
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.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
m_buffer | |||||||||||
m_head | |||||||||||
m_tail |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an UnboundedFifoBuffer with the default number of elements.
| |||||||||||
Constructs an UnboundedFifoBuffer with the specified number of elements.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds the given element to this buffer.
| |||||||||||
Returns the next object in the buffer.
| |||||||||||
Returns true if this buffer is empty; false otherwise.
| |||||||||||
Returns an iterator over this buffer's elements.
| |||||||||||
Removes the next object from the buffer
| |||||||||||
Returns the number of elements stored in the buffer.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.util.AbstractCollection
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Iterable
| |||||||||||
From interface
java.util.Collection
| |||||||||||
From interface
org.apache.commons.collections.Buffer
|
Constructs an UnboundedFifoBuffer with the default number of elements. It is exactly the same as performing the following:
new UnboundedFifoBuffer(32);
Constructs an UnboundedFifoBuffer with the specified number of elements. The integer must be a positive integer.
initialSize | the initial size of the buffer |
---|
IllegalArgumentException | if the size is less than 1 |
---|
Adds the given element to this buffer.
obj | the element to add |
---|
NullPointerException | if the given element is null |
---|---|
BufferOverflowException | if this buffer is full |
Returns the next object in the buffer.
BufferUnderflowException | if this buffer is empty |
---|
Returns true if this buffer is empty; false otherwise.
Returns an iterator over this buffer's elements.
Removes the next object from the buffer
BufferUnderflowException | if this buffer is empty |
---|
Returns the number of elements stored in the buffer.