edu.ucla.sspace.util

Interface SortedMultiMap<K,V>

All Superinterfaces:

MultiMap<K,V>

All Known Implementing Classes:

BoundedSortedMultiMap, TreeMultiMap

public interface SortedMultiMap<K,V>
extends MultiMap<K,V>

A MultiMap that provides a total ordering for the keys. All keys intersted must implement the Comparable interface.

See Also:

MultiMap, SortedMap

Method Summary

Methods

Modifier and Type	Method and Description
Comparator<? super K>	comparator() Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys.
K	firstKey() Returns a Set view of the mappings contained in this map.
SortedMultiMap<K,V>	headMap(K toKey) Returns a view of the portion of this map whose keys are less than toKey.
K	lastKey() Returns the last (highest) key currently in this map.
SortedMultiMap<K,V>	subMap(K fromKey, K toKey) Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
SortedMultiMap<K,V>	tailMap(K fromKey) Returns a view of the portion of this map whose keys are greater than or equal to fromKey.

Methods inherited from interface edu.ucla.sspace.util.MultiMap

asMap, clear, containsKey, containsMapping, containsValue, entrySet, get, isEmpty, keySet, put, putAll, putAll, putMany, range, remove, remove, size, values, valueSets

Method Detail

comparator

Comparator<? super K> comparator()

Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys.

firstKey

K firstKey()

Returns a Set view of the mappings contained in this map.

headMap

SortedMultiMap<K,V> headMap(K toKey)

Returns a view of the portion of this map whose keys are less than toKey.

lastKey

K lastKey()

Returns the last (highest) key currently in this map.

subMap

SortedMultiMap<K,V> subMap(K fromKey,
                         K toKey)

Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.

tailMap

SortedMultiMap<K,V> tailMap(K fromKey)

Returns a view of the portion of this map whose keys are greater than or equal to fromKey.