it.unimi.dsi.fastutil.objects

Interface Object2ObjectSortedMap<K,V>

All Superinterfaces:

Function<K,V>, Map<K,V>, Object2ObjectFunction<K,V>, Object2ObjectMap<K,V>, SortedMap<K,V>

All Known Implementing Classes:

AbstractObject2ObjectSortedMap, Object2ObjectAVLTreeMap, Object2ObjectLinkedOpenCustomHashMap, Object2ObjectLinkedOpenHashMap, Object2ObjectRBTreeMap, Object2ObjectSortedMaps.EmptySortedMap, Object2ObjectSortedMaps.Singleton, Object2ObjectSortedMaps.SynchronizedSortedMap, Object2ObjectSortedMaps.UnmodifiableSortedMap

public interface Object2ObjectSortedMap<K,V>
extends Object2ObjectMap<K,V>, SortedMap<K,V>

A type-specific SortedMap; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens entrySet(), keySet(), values(), comparator(), SortedMap.subMap(Object,Object), SortedMap.headMap(Object) and SortedMap.tailMap(Object).

See Also:

SortedMap

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Object2ObjectSortedMap.FastSortedEntrySet<K,V> A sorted entry set providing fast iteration.

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ObjectMap

Object2ObjectMap.Entry<K,V>, Object2ObjectMap.FastEntrySet<K,V>

Method Summary

Modifier and Type	Method and Description
Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
ObjectSortedSet<Map.Entry<K,V>>	entrySet() Returns a sorted-set view of the mappings contained in this map.
Object2ObjectSortedMap<K,V>	headMap(K toKey) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<K>	keySet() Returns a sorted-set view of the keys contained in this map.
ObjectSortedSet<Object2ObjectMap.Entry<K,V>>	object2ObjectEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
Object2ObjectSortedMap<K,V>	subMap(K fromKey, K toKey) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Object2ObjectSortedMap<K,V>	tailMap(K fromKey) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ObjectCollection<V>	values() Returns a set view of the values contained in this map.

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ObjectFunction

defaultReturnValue, defaultReturnValue

Methods inherited from interface it.unimi.dsi.fastutil.Function

clear, containsKey, get, put, remove, size

Methods inherited from interface java.util.SortedMap

firstKey, lastKey

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Method Detail

entrySet

ObjectSortedSet<Map.Entry<K,V>> entrySet()

Returns a sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface Object2ObjectMap<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

Returns:

a sorted-set view of the mappings contained in this map.

See Also:

Map.entrySet()

object2ObjectEntrySet

ObjectSortedSet<Object2ObjectMap.Entry<K,V>> object2ObjectEntrySet()

Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<K,V>

Returns:

a type-specific sorted-set view of the mappings contained in this map.

See Also:

entrySet()

keySet

ObjectSortedSet<K> keySet()

Returns a sorted-set view of the keys contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface Object2ObjectMap<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Returns:

a sorted-set view of the keys contained in this map.

See Also:

Map.keySet()

values

ObjectCollection<V> values()

Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends SortedMap.

Specified by:

values in interface Map<K,V>

Specified by:

values in interface Object2ObjectMap<K,V>

Specified by:

values in interface SortedMap<K,V>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

comparator

Comparator<? super K> comparator()

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

Specified by:

comparator in interface SortedMap<K,V>

See Also:

SortedMap.comparator()

subMap

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

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

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:

subMap in interface SortedMap<K,V>

See Also:

SortedMap.subMap(Object,Object)

headMap

Object2ObjectSortedMap<K,V> headMap(K toKey)

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

Note that this specification strengthens the one given in SortedMap.headMap(Object).

Specified by:

headMap in interface SortedMap<K,V>

See Also:

SortedMap.headMap(Object)

tailMap

Object2ObjectSortedMap<K,V> tailMap(K fromKey)

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

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

Specified by:

tailMap in interface SortedMap<K,V>

See Also:

SortedMap.tailMap(Object)