at.tuwien.ifs.commons.util.collection
Class SmallestElementSet<E extends Comparable<E>>

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractSet<E>
          extended by java.util.TreeSet<E>
              extended by at.tuwien.ifs.commons.util.collection.SmallestElementSet<E>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>

public class SmallestElementSet<E extends Comparable<E>>
extends 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
private  int maxElementCount
           
(package private) static long serialVersionUID
           
 
Constructor Summary
SmallestElementSet(int maxElementCount)
           
 
Method Summary
 boolean add(E element)
           
 boolean addAll(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, 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
 

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 Collection<E extends Comparable<E>>
Specified by:
add in interface Set<E extends Comparable<E>>
Overrides:
add in class TreeSet<E extends Comparable<E>>
Returns:
true if this set was modified by the operation

addAll

public boolean addAll(Collection<? extends E> collection)
Specified by:
addAll in interface Collection<E extends Comparable<E>>
Specified by:
addAll in interface Set<E extends Comparable<E>>
Overrides:
addAll in class TreeSet<E extends Comparable<E>>