|
||||||||||
| 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.BoundedFifoBuffer
public class BoundedFifoBuffer
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.
| Constructor Summary | |
|---|---|
BoundedFifoBuffer()
Deprecated. Constructs a new BoundedFifoBuffer big enough to hold
32 elements. |
|
BoundedFifoBuffer(java.util.Collection coll)
Deprecated. Constructs a new BoundedFifoBuffer big enough to hold all
of the elements in the specified collection. |
|
BoundedFifoBuffer(int size)
Deprecated. Constructs a new BoundedFifoBuffer big enough to hold
the specified number of elements. |
|
| Method Summary | |
|---|---|
boolean |
add(java.lang.Object element)
Deprecated. Adds the given element to this buffer. |
void |
clear()
Deprecated. Clears this buffer. |
java.lang.Object |
get()
Deprecated. Returns the least recently inserted element in this buffer. |
boolean |
isEmpty()
Deprecated. Returns true if this buffer is empty; false otherwise. |
boolean |
isFull()
Deprecated. Returns true if this collection is full and no new elements can be added. |
java.util.Iterator |
iterator()
Deprecated. Returns an iterator over this buffer's elements. |
int |
maxSize()
Deprecated. Gets the maximum size of the collection (the bound). |
java.lang.Object |
remove()
Deprecated. Removes the least recently inserted element from this buffer. |
int |
size()
Deprecated. Returns the number of elements stored in the buffer. |
| Methods inherited from class java.util.AbstractCollection |
|---|
addAll, 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, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray |
| Methods inherited from interface java.util.Collection |
|---|
addAll, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray |
| Constructor Detail |
|---|
public BoundedFifoBuffer()
BoundedFifoBuffer big enough to hold
32 elements.
public BoundedFifoBuffer(int size)
BoundedFifoBuffer big enough to hold
the specified number of elements.
size - the maximum number of elements for this fifo
java.lang.IllegalArgumentException - if the size is less than 1public BoundedFifoBuffer(java.util.Collection coll)
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
java.lang.NullPointerException - if the collection is null| 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 isFull()
isFull in interface BoundedCollectiontrue if the collection is fullpublic int maxSize()
maxSize in interface BoundedCollectionpublic void clear()
clear in interface java.util.Collectionclear in class java.util.AbstractCollectionpublic boolean add(java.lang.Object element)
add in interface java.util.Collectionadd in class java.util.AbstractCollectionelement - 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 BufferBufferUnderflowException - if the buffer is emptypublic java.lang.Object remove()
remove in interface BufferBufferUnderflowException - if the 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 | |||||||||