FixedSizeCircularBuffer

FRAMES NO FRAMES

Overview

Deprecated

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apamax.containers
Event FixedSizeCircularBuffer

A fixed-sized circular buffer object.

Once the buffer is full, adding another value removes the oldest one in the buffer.

Action summary
`integer`	`capacity()` Return the capacity of this circular buffer.
`void`	`clear()` Remove all the values in the buffer.
`com.apamax.containers.FixedSizeCircularBuffer`	`static` `create(integer size)` Create an empty buffer of a particular size.
`boolean`	`empty()` Returns true if the buffer is empty.
`boolean`	`full()` Returns true if the buffer is full (size() == capacity()).
`any`	`get(integer offs)` Return the item currently at the given position in the buffer.
`sequence<any>`	`getData()` Return the underlying sequence containing the circular buffer in order. This is returned by reference. You should not modify the return value, only clone it or iterate over it.
`void`	`push(any val)` Push a value onto the buffer. If the buffer is full, removes the oldest value.
`integer`	`size()` Return the number of values in the buffer.

Action detail

capacity

integer capacity()

Return the capacity of this circular buffer.

clear

void clear()

Remove all the values in the buffer.

create

com.apamax.containers.FixedSizeCircularBuffer static create(integer size)

Create an empty buffer of a particular size.

Parameters:: size - The maximum capacity of the buffer.

empty

boolean empty()

Returns true if the buffer is empty.

full

boolean full()

Returns true if the buffer is full (size() == capacity()).

get

any get(integer offs)

Return the item currently at the given position in the buffer.

Parameters:: offs - The offset into the buffer, with 0 being the oldest and capacity-1 being the most recent.

getData

sequence<any> getData()

Return the underlying sequence containing the circular buffer in order. This is returned by reference. You should not modify the return value, only clone it or iterate over it.

push

void push(any val)

Push a value onto the buffer. If the buffer is full, removes the oldest value.

Parameters:: val - The value to add to the buffer.

size

integer size()

Return the number of values in the buffer.