ix.internal.util

Class CircularBuffer<T>

java.lang.Object

ix.internal.util.CircularBuffer<T>

Type Parameters:

T - the contained element type

public class CircularBuffer<T>
extends java.lang.Object

A simple circular buffer with absolute indices.

Constructor Summary

Constructors

Constructor and Description
CircularBuffer(int size) Construct a new circular buffer.

Method Summary

Modifier and Type	Method and Description
void	add(T value) Add a new value to the buffer.
T	get(int index) Retrieve a buffer element based on an absolute index.
int	head()
boolean	isEmpty()
int	size()
int	tail()
T	take()

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularBuffer

public CircularBuffer(int size)

Construct a new circular buffer.

Parameters:

size - the buffer size

Method Detail

add

public void add(T value)

Add a new value to the buffer. If the buffer would overflow, it automatically removes the current head element.

Parameters:

value - the value

get

public T get(int index)

Retrieve a buffer element based on an absolute index.

Parameters:

index - the absolute index

Returns:

the value

take

public T take()

Returns:

Takes the head of the buffer.

isEmpty

public boolean isEmpty()

Returns:

is the buffer empty?

size

public int size()

Returns:

the current size of the buffer.

head

public int head()

Returns:

the current head index.

tail

public int tail()

Returns:

the current tail index.