de.gsi.dataset.utils

Class CircularBuffer<E>

java.lang.Object

de.gsi.dataset.utils.CircularBuffer<E>

Type Parameters:

E - the generic Object to be stored

public class CircularBuffer<E>
extends Object

simple circular ring buffer implementation for generic object type (with read == write position)

Author:

rstein

Constructor Summary

Constructors

Constructor and Description
CircularBuffer(int capacity)

Method Summary

Modifier and Type	Method and Description
int	available()
E	get()
E[]	get(E[] into, int length)
E[]	get(E[] into, int readPos, int length)
E	get(int readPos)
boolean	put(E element)
int	put(E[] newElements, int length) add multiple new elements
int	put(E[] newElements, int startIndex, int length) add multiple new elements
int	remainingCapacity()
void	reset() resets buffer

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularBuffer

public CircularBuffer(int capacity)

Parameters:

capacity - maximum capacity of the buffer

Method Detail

available

public int available()

Returns:

number of available buffer elements

get

public E get()

Returns:

value at head

get

public E[] get(E[] into,
               int length)

Parameters:

into - storage container

length - number of elements to be read

Returns:

either into or newly allocated array containing the result

get

public E[] get(E[] into,
               int readPos,
               int length)

Parameters:

into - storage container

readPos - circular index (wraps around)

length - number of elements to be read

Returns:

either into or newly allocated array containing the result

get

public E get(int readPos)

Parameters:

readPos - circular index (wraps around)

Returns:

the value

put

public boolean put(E element)

Parameters:

element - new element

Returns:

true

put

public int put(E[] newElements,
               int length)

add multiple new elements

Parameters:

newElements - array of new elements

length - number of elements that are to be written from array

Returns:

true: write index is smaller than read index

put

public int put(E[] newElements,
               int startIndex,
               int length)

add multiple new elements

Parameters:

newElements - array of new elements

startIndex - 'null'

length - number of elements that are to be written from array

Returns:

true: write index is smaller than read index

remainingCapacity

public int remainingCapacity()

Returns:

number of available buffer elements that can be written before buffer wraps-around

reset

public void reset()

resets buffer