com.helger.collection.ring

Class RingBufferFifo<ELEMENTTYPE>

java.lang.Object

com.helger.collection.ring.RingBufferFifo<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The elements contained in the ring buffer.

@NotThreadSafe
public class RingBufferFifo<ELEMENTTYPE>
extends Object

A FIFO (first in first out) ring buffer.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
RingBufferFifo(int nCapacity, boolean bAllowOverwrite) Constructor

Method Summary

Modifier and Type	Method and Description
int	getAvailable()
int	getCapacity()
int	getRemainingCapacity()
boolean	isOverwriteAllowed()
com.helger.commons.state.EChange	put(ELEMENTTYPE aElement) Add a new element into the ring buffer
void	reset() Reset the buffer so that it is empty again.
ELEMENTTYPE	take() Take an element from the ring buffer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RingBufferFifo

public RingBufferFifo(@Nonnegative
                      int nCapacity,
                      boolean bAllowOverwrite)

Constructor

Parameters:

nCapacity - The number of elements in the ring buffer. Must be > 0.

bAllowOverwrite - true if the oldest element gets overwritten when the next element is put.

Method Detail

reset

public void reset()

Reset the buffer so that it is empty again.

getCapacity

@Nonnegative
public int getCapacity()

Returns:

The capacity as stated in the constructor. Always > 0.

getAvailable

@Nonnegative
public int getAvailable()

Returns:

The number of available elements in the ring buffer. Always ≥ 0.

getRemainingCapacity

@Nonnegative
public int getRemainingCapacity()

Returns:

The number of free elements in the ring buffer. Always ≥ 0.

isOverwriteAllowed

public boolean isOverwriteAllowed()

Returns:

true if overwriting the oldest element is allowed (as specified in the constructor).

put

@Nonnull
public com.helger.commons.state.EChange put(@Nullable
                                                      ELEMENTTYPE aElement)

Add a new element into the ring buffer

Parameters:

aElement - The element to be added. May be null.

Returns:

EChange.CHANGED if the element was successfully added or if allow overwrite is active and the element was overwritten.

take

@Nullable
public ELEMENTTYPE take()

Take an element from the ring buffer.

Returns:

null if no more element is available or if the current element is null.

toString

public String toString()

Overrides:

toString in class Object