org.jowidgets.util.collection

Interface ICircularBuffer<ELEMENT_TYPE>

public interface ICircularBuffer<ELEMENT_TYPE>

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ELEMENT_TYPE element) Adds an element to the end of buffer.
int	capacity()
void	clear() Clears the current buffer
ELEMENT_TYPE	get(int index) Gets the element at the specific index or null, if no element was added to the index before
int	size() The current size of the buffer.

Method Detail

capacity

int capacity()

Returns:

The capacity of the circular buffer.

size

int size()

The current size of the buffer. If the buffer is not full, the number of added elements, other the capacity will be returned.

Returns:

The current size of the buffer

add

void add(ELEMENT_TYPE element)

Adds an element to the end of buffer. If the buffer is full, all elements are shifted to the left and the first element will be removed. This operation will be done in O(1).

Parameters:

element - The element to add, may be null

get

ELEMENT_TYPE get(int index)

Gets the element at the specific index or null, if no element was added to the index before

Parameters:

index - The index (0 <= index < capacity)

Returns:

The element

clear

void clear()

Clears the current buffer