org.apache.flink.runtime.util

Class EvictingBoundedList<T>

java.lang.Object

org.apache.flink.runtime.util.EvictingBoundedList<T>

Type Parameters:

T - type of the list elements

All Implemented Interfaces:

Serializable, Iterable<T>

public class EvictingBoundedList<T>
extends Object
implements Iterable<T>, Serializable

This class implements a list (array based) that is physically bounded in maximum size, but can virtually grow beyond the bounded size. When the list grows beyond the size bound, elements are dropped from the head of the list (FIFO order). If dropped elements are accessed, a default element is returned instead.

The list by itself is serializable, but a full list can only be serialized if the values are also serializable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EvictingBoundedList.Function<I,O> A simple unary function that can be used to transform elements via the map(Function) method.

Constructor Summary

Constructors

Constructor and Description
EvictingBoundedList(EvictingBoundedList<T> other)
EvictingBoundedList(int sizeLimit)
EvictingBoundedList(int sizeLimit, T defaultElement)

Method Summary

Modifier and Type	Method and Description
boolean	add(T t)
void	clear()
T	get(int index)
T	getDefaultElement()
int	getSizeLimit()
boolean	isEmpty()
Iterator<T>	iterator()
<R> EvictingBoundedList<R>	map(EvictingBoundedList.Function<T,R> transform) Creates a new list that replaces its elements with transformed elements.
T	set(int index, T element)
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EvictingBoundedList

public EvictingBoundedList(int sizeLimit)

EvictingBoundedList

public EvictingBoundedList(EvictingBoundedList<T> other)

EvictingBoundedList

public EvictingBoundedList(int sizeLimit,
                           T defaultElement)

Method Detail

size

public int size()

isEmpty

public boolean isEmpty()

add

public boolean add(T t)

clear

public void clear()

get

public T get(int index)

getSizeLimit

public int getSizeLimit()

set

public T set(int index,
             T element)

getDefaultElement

public T getDefaultElement()

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

map

public <R> EvictingBoundedList<R> map(EvictingBoundedList.Function<T,R> transform)

Creates a new list that replaces its elements with transformed elements. The list retains the same size and position-to-element mapping.

Note that null values are automatically mapped to null values.

Type Parameters:

R - The type of the elements in the result list.

Parameters:

transform - The function used to transform each element

Returns:

The list with the mapped elements