Class CircularFifoQueue<E>
java.lang.Object
java.util.AbstractCollection<E>
org.apache.commons.collections4.queue.CircularFifoQueue<E>
- Type Parameters:
E- the type of elements in this collection
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,Queue<E>,BoundedCollection<E>
public class CircularFifoQueue<E>
extends AbstractCollection<E>
implements Queue<E>, BoundedCollection<E>, Serializable
CircularFifoQueue is a first-in first-out queue with a fixed size that
replaces its oldest element if full.
The removal order of a CircularFifoQueue 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(), peek(), poll(),
offer(Object) operations all perform in constant time.
All other operations perform in linear time or worse.
This queue prevents null objects from being added.
- Since:
- 4.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor that creates a queue with the default size of 32.CircularFifoQueue(int size) Constructor that creates a queue with the specified size.CircularFifoQueue(Collection<? extends E> coll) Constructor that creates a queue from the specified collection. -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds the given element to this queue.voidclear()Clears this queue.element()get(int index) Gets the element at the specified position in this queue.booleanReturnstrueif the capacity limit of this queue has been reached, i.e. the number of elements stored in the queue equals its maximum size.booleanisEmpty()Returns true if this queue is empty; false otherwise.booleanisFull()Returns true if this collection is full and no new elements can be added.iterator()Returns an iterator over this queue's elements.intmaxSize()Gets the maximum size of the collection (the bound).booleanAdds the given element to this queue.peek()poll()remove()intsize()Returns the number of elements stored in the queue.Methods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
addAll, contains, containsAll, equals, hashCode, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray
-
Constructor Details
-
CircularFifoQueue
public CircularFifoQueue()Constructor that creates a queue with the default size of 32. -
CircularFifoQueue
Constructor that creates a queue from the specified collection. The collection size also sets the queue size.- Parameters:
coll- the collection to copy into the queue, may not be null- Throws:
NullPointerException- if the collection is null
-
CircularFifoQueue
Constructor that creates a queue with the specified size.- Parameters:
size- the size of the queue (cannot be changed)- Throws:
IllegalArgumentException- if the size is < 1
-
-
Method Details
-
add
Adds the given element to this queue. If the queue is full, the least recently added element is discarded so that a new element can be inserted.- Specified by:
addin interfaceCollection<E>- Specified by:
addin interfaceQueue<E>- Overrides:
addin classAbstractCollection<E>- Parameters:
element- the element to add- Returns:
- true, always
- Throws:
NullPointerException- if the given element is null
-
clear
Clears this queue.- Specified by:
clearin interfaceCollection<E>- Overrides:
clearin classAbstractCollection<E>
-
element
-
get
Gets the element at the specified position in this queue.- Parameters:
index- the position of the element in the queue- Returns:
- the element at position
index - Throws:
NoSuchElementException- if the requested position is outside the range [0, size)
-
isAtFullCapacity
Returnstrueif the capacity limit of this queue has been reached, i.e. the number of elements stored in the queue equals its maximum size.- Returns:
trueif the capacity limit has been reached,falseotherwise- Since:
- 4.1
-
isEmpty
Returns true if this queue is empty; false otherwise.- Specified by:
isEmptyin interfaceCollection<E>- Overrides:
isEmptyin classAbstractCollection<E>- Returns:
- true if this queue is empty
-
isFull
Returns true if this collection is full and no new elements can be added.A
CircularFifoQueuecan never be full, thus this returns alwaysfalse.- Specified by:
isFullin interfaceBoundedCollection<E>- Returns:
- always returns
false
-
iterator
-
maxSize
Gets the maximum size of the collection (the bound).- Specified by:
maxSizein interfaceBoundedCollection<E>- Returns:
- the maximum number of elements the collection can hold
-
offer
Adds the given element to this queue. If the queue is full, the least recently added element is discarded so that a new element can be inserted.- Specified by:
offerin interfaceQueue<E>- Parameters:
element- the element to add- Returns:
- true, always
- Throws:
NullPointerException- if the given element is null
-
peek
-
poll
-
remove
-
size
Returns the number of elements stored in the queue.- Specified by:
sizein interfaceCollection<E>- Specified by:
sizein classAbstractCollection<E>- Returns:
- this queue's size
-