xal.tools.collections

Interface IBoundedList<T>

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

LinearBuffer

public interface IBoundedList<T>
extends java.lang.Iterable<T>

Interface presented by class types representing bounded lists, that is, bounded buffers. This interface is primarily indicative in nature, obviate the intention of the exposing type. However, it does contain most of the methods typically needed to use such a collection.

An important aspect of a bounded buffer is the iterator it provides. For example, are the contained elements traversed first in first out, last in first out, as a queue, as a dequeue, etc. Thus, this interface inherits from the Iterable interface in anticipation of such an iteration process.

Since:

Apr 11, 2013

Method Summary

Modifier and Type	Method and Description
void	add(T item) Adds an object to the list, potentially pushing off the oldest object if the buffer is full.
void	clear() Clears the entire contents of the list.
T	get(int index) Return the object at the specified index position in this list.
int	size() Returns the size of the bounded list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

size

int size()

Returns the size of the bounded list.

Returns:

maximum number of objects that the list can manage

Since:

Apr 11, 2013

add

void add(T item)

Adds an object to the list, potentially pushing off the oldest object if the buffer is full.

Parameters:

objNew - object to be inserted into the list

Since:

Apr 11, 2013

get

T get(int index)

Return the object at the specified index position in this list. The relative meaning of the index may be interpreted differently for each type of list.

Parameters:

index - index position into the list

Returns:

object at position index

Since:

Apr 11, 2013

clear

void clear()

Clears the entire contents of the list. That is, empties the current list.

Since:

Apr 11, 2013