Package uk.gov.gchq.gaffer.commonutil.iterable

Class LimitedInMemorySortedIterable<E>

java.lang.Object

uk.gov.gchq.gaffer.commonutil.iterable.LimitedInMemorySortedIterable<E>

Type Parameters:

E - the type of object to store in the LimitedInMemorySortedIterable.

All Implemented Interfaces:

Iterable<E>

public class LimitedInMemorySortedIterable<E>
extends Object
implements Iterable<E>

An Iterable which can sort, limit and deduplicate its elements. Sorting is achieved with a provided Comparator.

This iterable is backed by a TreeMap, with items being dropped from the end of the backing TreeMap. To allow duplicates and to be stored the TreeMap is a map of item to collection of items. The tree map uses the comparator for equality checking, so the collection of items will contain items with a comparator score of 0, but potentially not equal using the equals method.

Constructor Summary

Constructors

Constructor	Description
LimitedInMemorySortedIterable(Comparator<E> comparator)
LimitedInMemorySortedIterable(Comparator<E> comparator, Integer limit)
LimitedInMemorySortedIterable(Comparator<E> comparator, Integer limit, boolean deduplicate)

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	addAll(Iterable<E> items)
boolean	equals(Object obj)
int	hashCode()
Iterator<E>	iterator()
int	size()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LimitedInMemorySortedIterable

public LimitedInMemorySortedIterable(Comparator<E> comparator)

LimitedInMemorySortedIterable

public LimitedInMemorySortedIterable(Comparator<E> comparator,
                                     Integer limit)

LimitedInMemorySortedIterable

public LimitedInMemorySortedIterable(Comparator<E> comparator,
                                     Integer limit,
                                     boolean deduplicate)

Method Detail

add

public boolean add(E e)

addAll

public boolean addAll(Iterable<E> items)

size

public int size()

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object