Interface CircularFifoBuffer<T>
-
- All Known Implementing Classes:
ConcurrentCircularFifoBuffer
public interface CircularFifoBuffer<T>ACircularFifoBufferis a first in first out buffer with a fixed size that replaces its oldest element if full.CircularFifoBufferdoes NOT accept null elements.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidadd(T element)Adds element to theCircularFifoBufferand overwrites the oldest element whenisFull().booleanisEmpty()Returnstrueif thisCircularFifoBuffercontains no elements.booleanisFull()Returnstrueif thisCircularFifoBufferis full.intsize()Returns the number of elements in thisCircularFifoBuffer.io.vavr.control.Option<T>take()Retrieves and removes the head of this queue, or returnsOption.Noneif this queue is empty.io.vavr.collection.List<T>toList()Returns a list containing all of the elements in thisCircularFifoBuffer.
-
-
-
Method Detail
-
size
int size()
Returns the number of elements in thisCircularFifoBuffer.- Returns:
- the number of elements in this
CircularFifoBuffer
-
isEmpty
boolean isEmpty()
Returnstrueif thisCircularFifoBuffercontains no elements.- Returns:
trueif thisCircularFifoBuffercontains no elements
-
isFull
boolean isFull()
Returnstrueif thisCircularFifoBufferis full.- Returns:
trueif thisCircularFifoBufferis full
-
toList
io.vavr.collection.List<T> toList()
Returns a list containing all of the elements in thisCircularFifoBuffer. The elements are copied into an array.- Returns:
- a list containing all of the elements in this
CircularFifoBuffer
-
add
void add(T element)
Adds element to theCircularFifoBufferand overwrites the oldest element whenisFull().- Parameters:
element- to add- Throws:
java.lang.NullPointerException- if the specified element is null
-
take
io.vavr.control.Option<T> take()
Retrieves and removes the head of this queue, or returnsOption.Noneif this queue is empty.- Returns:
- the head of this queue, or
Option.Noneif this queue is empty
-
-