org.semanticweb.elk.util.collections

Interface Evictor<E>

Type Parameters:

E - The type of the elements.

All Superinterfaces:

HasStats

All Known Implementing Classes:

AbstractEvictor, CapacityBalancingEvictor, CountingEvictor, NQEvictor, RecencyEvictor

public interface Evictor<E>
extends HasStats

Keeps track of added elements and informs of which of these elements were evicted.

Author:

Peter Skocovsky

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Evictor.Builder

Method Summary

Modifier and Type	Method and Description
void	add(E element) Add the provided element.
Iterator<E>	addAndEvict(E element) Add the provided element and return elements that were evicted.
Iterator<E>	addAndEvict(E element, com.google.common.base.Predicate<E> retain) Add the provided element and return elements that were evicted.
Iterator<E>	evict() Return elements that are evicted.
Iterator<E>	evict(com.google.common.base.Predicate<E> retain) Return elements that are evicted.

Methods inherited from interface org.semanticweb.elk.util.statistics.HasStats

getStats

Method Detail

add

void add(E element)

Add the provided element.

Parameters:

element - The added element.

evict

Iterator<E> evict()

Return elements that are evicted.

Returns:

The evicted elements.

evict

Iterator<E> evict(com.google.common.base.Predicate<E> retain)

Return elements that are evicted. Does not evict the elements for which retain returns true.

Parameters:

retain - A Predicate that is true for elements that should be retained.

Returns:

The evicted elements.

addAndEvict

Iterator<E> addAndEvict(E element)

Add the provided element and return elements that were evicted.

Parameters:

element - The added element.

Returns:

The evicted elements.

addAndEvict

Iterator<E> addAndEvict(E element,
                        com.google.common.base.Predicate<E> retain)

Add the provided element and return elements that were evicted. Does not evict the elements for which retain returns true.

Parameters:

element - The added element.

retain - A Predicate that is true for elements that should be retained.

Returns:

The evicted elements.