Package org.apache.commons.collections
Class UnboundedFifoBuffer
java.lang.Object
java.util.AbstractCollection
org.apache.commons.collections.UnboundedFifoBuffer
- All Implemented Interfaces:
Iterable
,Collection
,Buffer
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.
- Since:
- Commons Collections 2.1
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Avalon, Federico Barbieri, Berin Loritsch, Paul Jack, Stephen Colebourne, Andreas Schlosser
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Constructs an UnboundedFifoBuffer with the default number of elements.UnboundedFifoBuffer
(int initialSize) Deprecated.Constructs an UnboundedFifoBuffer with the specified number of elements. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.Adds the given element to this buffer.get()
Deprecated.Returns the next object in the buffer.boolean
isEmpty()
Deprecated.Returns true if this buffer is empty; false otherwise.iterator()
Deprecated.Returns an iterator over this buffer's elements.remove()
Deprecated.Removes the next object from the bufferint
size()
Deprecated.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, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray
-
Field Details
-
m_buffer
Deprecated. -
m_head
protected int m_headDeprecated. -
m_tail
protected int m_tailDeprecated.
-
-
Constructor Details
-
UnboundedFifoBuffer
public UnboundedFifoBuffer()Deprecated.Constructs an UnboundedFifoBuffer with the default number of elements. It is exactly the same as performing the following:new UnboundedFifoBuffer(32);
-
UnboundedFifoBuffer
public UnboundedFifoBuffer(int initialSize) Deprecated.Constructs an UnboundedFifoBuffer with the specified number of elements. The integer must be a positive integer.- Parameters:
initialSize
- the initial size of the buffer- Throws:
IllegalArgumentException
- if the size is less than 1
-
-
Method Details
-
size
public int size()Deprecated.Returns the number of elements stored in the buffer.- Specified by:
size
in interfaceCollection
- Specified by:
size
in classAbstractCollection
- Returns:
- this buffer's size
-
isEmpty
public boolean isEmpty()Deprecated.Returns true if this buffer is empty; false otherwise.- Specified by:
isEmpty
in interfaceCollection
- Overrides:
isEmpty
in classAbstractCollection
- Returns:
- true if this buffer is empty
-
add
Deprecated.Adds the given element to this buffer.- Specified by:
add
in interfaceCollection
- Overrides:
add
in classAbstractCollection
- Parameters:
obj
- the element to add- Returns:
- true, always
- Throws:
NullPointerException
- if the given element is nullBufferOverflowException
- if this buffer is full
-
get
Deprecated.Returns the next object in the buffer.- Specified by:
get
in interfaceBuffer
- Returns:
- the next object in the buffer
- Throws:
BufferUnderflowException
- if this buffer is empty
-
remove
Deprecated.Removes the next object from the buffer- Specified by:
remove
in interfaceBuffer
- Returns:
- the removed object
- Throws:
BufferUnderflowException
- if this buffer is empty
-
iterator
Deprecated.Returns an iterator over this buffer's elements.- Specified by:
iterator
in interfaceCollection
- Specified by:
iterator
in interfaceIterable
- Specified by:
iterator
in classAbstractCollection
- Returns:
- an iterator over this buffer's elements
-