Class UnboundedFifoBuffer
- java.lang.Object
-
- java.util.AbstractCollection
-
- org.apache.commons.collections.buffer.UnboundedFifoBuffer
-
- All Implemented Interfaces:
Serializable
,Iterable
,Collection
,Buffer
@Deprecated(since="2021-04-30") public class UnboundedFifoBuffer extends AbstractCollection implements Buffer, Serializable
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.UnboundedFifoBuffer is a very efficient implementation ofBuffer
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()
andget()
operations perform in constant time. Theadd(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.
- Since:
- Commons Collections 3.0 (previously in main package v2.1)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description UnboundedFifoBuffer()
Deprecated.Constructs an UnboundedFifoBuffer with the default number of elements.UnboundedFifoBuffer(int initialSize)
Deprecated.Constructs an UnboundedFifoBuffer with the specified number of elements.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(Object obj)
Deprecated.Adds the given element to this buffer.Object
get()
Deprecated.Returns the next object in the buffer.boolean
isEmpty()
Deprecated.Returns true if this buffer is empty; false otherwise.Iterator
iterator()
Deprecated.Returns an iterator over this buffer's elements.Object
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
equals, 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
-
-
-
-
Constructor Detail
-
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 Detail
-
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
public boolean add(Object obj)
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 null
-
get
public Object 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
public Object 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
public Iterator 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
-
-