Package io.github.resilience4j.circularbuffer

Class ConcurrentCircularFifoBuffer<T>

java.lang.Object

io.github.resilience4j.circularbuffer.ConcurrentCircularFifoBuffer<T>

All Implemented Interfaces:

CircularFifoBuffer<T>

public class ConcurrentCircularFifoBuffer<T>
extends Object
implements CircularFifoBuffer<T>

Thread safe implementation of CircularFifoBuffer on top of ConcurrentEvictingQueue

Constructor Summary

Constructors

Constructor	Description
ConcurrentCircularFifoBuffer(int capacity)	Creates an ConcurrentCircularFifoBuffer with the given (fixed) capacity

Method Summary

Modifier and Type	Method	Description
void	add(T element)	Adds element to the CircularFifoBuffer and overwrites the oldest element when CircularFifoBuffer.isFull().
boolean	isEmpty()	Returns true if this CircularFifoBuffer contains no elements.
boolean	isFull()	Returns true if this CircularFifoBuffer is full.
int	size()	Returns the number of elements in this CircularFifoBuffer.
Optional<T>	take()	Retrieves and removes the head of this queue, or returns Optional.empty() if this queue is empty.
List<T>	toList()	Returns a list containing all of the elements in this CircularFifoBuffer.
Stream<T>	toStream()	Returns a stream of the elements in this CircularFifoBuffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConcurrentCircularFifoBuffer

public ConcurrentCircularFifoBuffer(int capacity)

Creates an ConcurrentCircularFifoBuffer with the given (fixed) capacity

Parameters:

capacity - the capacity of this ConcurrentCircularFifoBuffer

Throws:

IllegalArgumentException - if capacity < 1

Method Details

size

public int size()

Returns the number of elements in this CircularFifoBuffer.

Specified by:

size in interface CircularFifoBuffer<T>

Returns:

the number of elements in this CircularFifoBuffer

isEmpty

public boolean isEmpty()

Returns true if this CircularFifoBuffer contains no elements.

Specified by:

isEmpty in interface CircularFifoBuffer<T>

Returns:

true if this CircularFifoBuffer contains no elements

isFull

public boolean isFull()

Returns true if this CircularFifoBuffer is full.

Specified by:

isFull in interface CircularFifoBuffer<T>

Returns:

true if this CircularFifoBuffer is full

toList

public List<T> toList()

Returns a list containing all of the elements in this CircularFifoBuffer. The elements are copied into an array.

Specified by:

toList in interface CircularFifoBuffer<T>

Returns:

a list containing all of the elements in this CircularFifoBuffer

toStream

public Stream<T> toStream()

Returns a stream of the elements in this CircularFifoBuffer.

Specified by:

toStream in interface CircularFifoBuffer<T>

Returns:

a stream of the elements in this CircularFifoBuffer

add

public void add(T element)

Adds element to the CircularFifoBuffer and overwrites the oldest element when CircularFifoBuffer.isFull().

Specified by:

add in interface CircularFifoBuffer<T>

Parameters:

element - to add

take

public Optional<T> take()

Retrieves and removes the head of this queue, or returns Optional.empty() if this queue is empty.

Specified by:

take in interface CircularFifoBuffer<T>

Returns:

the head of this queue, or Optional.empty() empty} if this queue is empty