org.lenskit.util.collections

Class SortedListAccumulator<T>

java.lang.Object

org.lenskit.util.collections.SortedListAccumulator<T>

public abstract class SortedListAccumulator<T>
extends java.lang.Object

Accumulators for sorted lists of things.

Method Summary

Modifier and Type	Method and Description
abstract void	add(T x) Add an item to the accumulator.
static <T extends java.lang.Comparable<? super T>> SortedListAccumulator<T>	decreasing(int n) Create a new sorted list accumulator.
static <T> SortedListAccumulator<T>	decreasing(int n, java.util.Comparator<? super T> comp) Create a new sorted list accumulator that sorts in decreasing order.
abstract java.util.List<T>	finish() Finish accumulating and return the accumulated items.

Methods inherited from class java.lang.Object

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

Method Detail

decreasing

public static <T extends java.lang.Comparable<? super T>> SortedListAccumulator<T> decreasing(int n)

Create a new sorted list accumulator.

Parameters:

n - The number of results desired; negative for unlimited.

Returns:

An accumulator accumulator.

decreasing

public static <T> SortedListAccumulator<T> decreasing(int n,
                                                      java.util.Comparator<? super T> comp)

Create a new sorted list accumulator that sorts in decreasing order.

Parameters:

n - The number of results desired; negative for unlimited.

comp - The comparator; items will be picked in decreasing order by this comparator.

Returns:

An accumulator accumulator.

add

public abstract void add(@Nonnull
                         T x)

Add an item to the accumulator.

Parameters:

x - The item to add.

finish

public abstract java.util.List<T> finish()

Finish accumulating and return the accumulated items.

When this method is called, the accumulator is reset and can be used to accumulate a fresh set of items.

Returns:

The accumulated items.