edu.ucla.sspace.util

Class BoundedSortedMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<K,V>

edu.ucla.sspace.util.BoundedSortedMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>

public class BoundedSortedMap<K,V>
extends TreeMap<K,V>

A Map implementation that grows to a fixed size and then retains only a fixed number of the highest (largest) keys. All keys used in this class must implements Comparable.

See Also:

BoundedSortedMultiMap, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
BoundedSortedMap(int bound) Creatins an instance that will only retain the specified number of the largest (highest) keys.
BoundedSortedMap(int bound, boolean retainHighest) Creatins an instance that will only retain the specified number of keys, where the largest (highest) keys.

Method Summary

Methods

Modifier and Type	Method and Description
V	put(K key, V value) Adds the key-value mapping to this map, and if the total number of mappings exceeds the bounds, removes either the currently lowest element, or if reversed, the currently highest element.
void	putAll(Map<? extends K,? extends V> m) Adds all of the key-value mapping to this map, and if the total number of mappings exceeds the bounds, removes mappings until the size is within bounds.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Constructor Detail

BoundedSortedMap

public BoundedSortedMap(int bound)

Creatins an instance that will only retain the specified number of the largest (highest) keys.

Parameters:

bound - the number of mappings to retain

BoundedSortedMap

public BoundedSortedMap(int bound,
                boolean retainHighest)

Creatins an instance that will only retain the specified number of keys, where the largest (highest) keys.

Parameters:

bound - the number of mappings to retain

retainHighest - true if the highest elements are to be retained, false if the lowest keys are to be retained

Method Detail

put

public V put(K key,
    V value)

Adds the key-value mapping to this map, and if the total number of mappings exceeds the bounds, removes either the currently lowest element, or if reversed, the currently highest element.

Specified by:

put in interface Map<K,V>

Overrides:

put in class TreeMap<K,V>

Parameters:

key -

value -

putAll

public void putAll(Map<? extends K,? extends V> m)

Adds all of the key-value mapping to this map, and if the total number of mappings exceeds the bounds, removes mappings until the size is within bounds.

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class TreeMap<K,V>

Parameters:

m -