|
||||||||||
| 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.buffer.UnboundedFifoBuffer
public class UnboundedFifoBuffer
UnboundedFifoBuffer is a very efficient implementation of
Buffer that can grow to any size.
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.
| Field Summary | |
|---|---|
protected java.lang.Object[] |
buffer
The array of objects in the buffer. |
protected int |
head
The current head index. |
protected int |
tail
The current tail index. |
| Constructor Summary | |
|---|---|
UnboundedFifoBuffer()
Constructs an UnboundedFifoBuffer with the default number of elements. |
|
UnboundedFifoBuffer(int initialSize)
Constructs an UnboundedFifoBuffer with the specified number of elements. |
|
| Method Summary | |
|---|---|
boolean |
add(java.lang.Object obj)
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 transient java.lang.Object[] buffer
protected transient int head
protected transient int tail
| Constructor Detail |
|---|
public UnboundedFifoBuffer()
new UnboundedFifoBuffer(32);
public UnboundedFifoBuffer(int initialSize)
initialSize - the initial size of the buffer
java.lang.IllegalArgumentException - if the size is less than 1| Method Detail |
|---|
public int size()
size in interface java.util.Collectionsize in class java.util.AbstractCollectionpublic boolean isEmpty()
isEmpty in interface java.util.CollectionisEmpty in class java.util.AbstractCollectionpublic boolean add(java.lang.Object obj)
add in interface java.util.Collectionadd in class java.util.AbstractCollectionobj - the element to add
java.lang.NullPointerException - if the given element is nullpublic java.lang.Object get()
get in interface BufferBufferUnderflowException - if this buffer is emptypublic java.lang.Object remove()
remove in interface BufferBufferUnderflowException - if this buffer is emptypublic java.util.Iterator iterator()
iterator in interface java.lang.Iterableiterator in interface java.util.Collectioniterator in class java.util.AbstractCollection
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||