|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection
org.apache.commons.collections.UnboundedFifoBuffer
public final class UnboundedFifoBuffer
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 UnboundedFifo
:
Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifo());
This buffer prevents null objects from being added.
Field Summary | |
---|---|
protected java.lang.Object[] |
m_buffer
|
protected int |
m_head
|
protected int |
m_tail
|
Constructor Summary | |
---|---|
UnboundedFifoBuffer()
Constructs an UnboundedFifoBuffer with the default number of elements. |
|
UnboundedFifoBuffer(int size)
Constructs an UnboundedFifoBuffer with the specified number of elements. |
Method Summary | |
---|---|
boolean |
add(java.lang.Object o)
Adds the given element to this buffer. |
java.lang.Object |
get()
Returns the next object in the 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 next object from the buffer |
int |
size()
Returns the number of elements stored in the buffer. |
Methods inherited from class java.util.AbstractCollection |
---|
addAll, clear, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Collection |
---|
addAll, clear, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray |
Field Detail |
---|
protected java.lang.Object[] m_buffer
protected int m_head
protected int m_tail
Constructor Detail |
---|
public UnboundedFifoBuffer()
new UnboundedFifoBuffer(32);
public UnboundedFifoBuffer(int size)
java.lang.IllegalArgumentException
- if the size is less than 1Method Detail |
---|
public boolean add(java.lang.Object o)
add
in interface java.util.Collection
add
in class java.util.AbstractCollection
element
- the element to add
java.lang.NullPointerException
- if the given element is null
BufferOverflowException
- if this buffer is fullpublic java.lang.Object get()
get
in interface Buffer
BufferUnderflowException
- if this 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 this buffer is emptypublic int size()
size
in interface java.util.Collection
size
in class java.util.AbstractCollection
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |