org.apache.commons.collections
public final class UnboundedFifoBuffer extends java.util.AbstractCollection implements Buffer
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.
Modifier and Type | Field and Description |
---|---|
protected java.lang.Object[] |
m_buffer |
protected int |
m_head |
protected int |
m_tail |
Constructor and Description |
---|
UnboundedFifoBuffer()
Constructs an UnboundedFifoBuffer with the default number of elements.
|
UnboundedFifoBuffer(int size)
Constructs an UnboundedFifoBuffer with the specified number of elements.
|
Modifier and Type | Method and Description |
---|---|
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.
|
addAll, clear, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString
protected java.lang.Object[] m_buffer
protected int m_head
protected int m_tail
public UnboundedFifoBuffer()
new UnboundedFifoBuffer(32);
public UnboundedFifoBuffer(int size)
java.lang.IllegalArgumentException
- if the size is less than 1public boolean add(java.lang.Object o)
add
in interface java.util.Collection
add
in class java.util.AbstractCollection
element
- the element to addjava.lang.NullPointerException
- if the given element is nullBufferOverflowException
- 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
Copyright © 2001-2004 Apache Software Foundation. Documenation generated March 13 2014.