at.tuwien.ifs.commons.util.collection

Class SmallestElementSet<E extends java.lang.Comparable<E>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<E>

at.tuwien.ifs.commons.util.collection.SmallestElementSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.NavigableSet<E>, java.util.Set<E>, java.util.SortedSet<E>

public class SmallestElementSet<E extends java.lang.Comparable<E>>
extends java.util.TreeSet<E>

A subclass of TreeSet that keeps only the smallest elements, up to a specified number of maximum elements.

Version:

$Id: SmallestElementSet.java 4211 2011-05-26 11:56:56Z mayer $

Author:

Rudolf Mayer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	maxElementCount
(package private) static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SmallestElementSet(int maxElementCount)

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
boolean	addAll(java.util.Collection<? extends E> collection)

Methods inherited from class java.util.TreeSet

ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

maxElementCount

private final int maxElementCount

Constructor Detail

SmallestElementSet

public SmallestElementSet(int maxElementCount)

Parameters:

maxElementCount - Maximum number of elements the set will keep

Method Detail

add

public boolean add(E element)

Specified by:

add in interface java.util.Collection<E extends java.lang.Comparable<E>>

Specified by:

add in interface java.util.Set<E extends java.lang.Comparable<E>>

Overrides:

add in class java.util.TreeSet<E extends java.lang.Comparable<E>>

Returns:

true if this set was modified by the operation

addAll

public boolean addAll(java.util.Collection<? extends E> collection)

Specified by:

addAll in interface java.util.Collection<E extends java.lang.Comparable<E>>

Specified by:

addAll in interface java.util.Set<E extends java.lang.Comparable<E>>

Overrides:

addAll in class java.util.TreeSet<E extends java.lang.Comparable<E>>