Package io.github.resilience4j.circularbuffer

Interface CircularFifoBuffer<T>

All Known Implementing Classes:
ConcurrentCircularFifoBuffer
public interface CircularFifoBuffer<T>
A CircularFifoBuffer is a first in first out buffer with a fixed size that replaces its oldest element if full. CircularFifoBuffer does NOT accept null elements.

  • Method Summary

    Modifier and Type Method Description
    void add​(T element)
    Adds element to the CircularFifoBuffer and overwrites the oldest element when 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.
    io.vavr.control.Option<T> take()
    Retrieves and removes the head of this queue, or returns Option.None if this queue is empty.
    io.vavr.collection.List<T> toList()
    Returns a list containing all of the elements in this CircularFifoBuffer.

  • Method Details

    • size

      int size()
      Returns the number of elements in this CircularFifoBuffer.
      Returns:
      the number of elements in this CircularFifoBuffer

    • isEmpty

      boolean isEmpty()
      Returns true if this CircularFifoBuffer contains no elements.
      Returns:
      true if this CircularFifoBuffer contains no elements

    • isFull

      boolean isFull()
      Returns true if this CircularFifoBuffer is full.
      Returns:
      true if this CircularFifoBuffer is full

    • toList

      io.vavr.collection.List<T> toList()
      Returns a list containing all of the elements in this CircularFifoBuffer. 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 the CircularFifoBuffer and overwrites the oldest element when isFull().
      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 returns Option.None if this queue is empty.
      Returns:
      the head of this queue, or Option.None if this queue is empty