it.unimi.dsi.fastutil.objects

Interface Object2ReferenceSortedMap<K,V>

All Superinterfaces:

Function<K,V>, Map<K,V>, Object2ReferenceFunction<K,V>, Object2ReferenceMap<K,V>, SortedMap<K,V>

All Known Implementing Classes:

AbstractObject2ReferenceSortedMap, Object2ReferenceAVLTreeMap, Object2ReferenceLinkedOpenCustomHashMap, Object2ReferenceLinkedOpenHashMap, Object2ReferenceRBTreeMap, Object2ReferenceSortedMaps.EmptySortedMap, Object2ReferenceSortedMaps.Singleton, Object2ReferenceSortedMaps.SynchronizedSortedMap, Object2ReferenceSortedMaps.UnmodifiableSortedMap

public interface Object2ReferenceSortedMap<K,V>
extends Object2ReferenceMap<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	Object2ReferenceSortedMap.FastSortedEntrySet<K,V> A sorted entry set providing fast iteration.

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

Object2ReferenceMap.Entry<K,V>, Object2ReferenceMap.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.
default ObjectSortedSet<Map.Entry<K,V>>	entrySet() Returns a sorted-set view of the mappings contained in this map.
Object2ReferenceSortedMap<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 type-specific sorted-set view of the keys contained in this map.
ObjectSortedSet<Object2ReferenceMap.Entry<K,V>>	object2ReferenceEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
Object2ReferenceSortedMap<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.
Object2ReferenceSortedMap<K,V>	tailMap(K fromKey) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ReferenceCollection<V>	values() Returns a type-specific set view of the values contained in this map.

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

clear, containsKey, defaultReturnValue, defaultReturnValue, put, remove, size

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

get

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.SortedMap

firstKey, lastKey

Methods inherited from interface java.util.Map

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

Method Detail

subMap

Object2ReferenceSortedMap<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>

Parameters:

fromKey - low endpoint (inclusive) of the keys in the returned map

toKey - high endpoint (exclusive) of the keys in the returned map

Returns:

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

See Also:

SortedMap.subMap(Object,Object)

headMap

Object2ReferenceSortedMap<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>

Parameters:

toKey - high endpoint (exclusive) of the keys in the returned map

Returns:

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

See Also:

SortedMap.headMap(Object)

tailMap

Object2ReferenceSortedMap<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>

Parameters:

fromKey - low endpoint (inclusive) of the keys in the returned map

Returns:

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

See Also:

SortedMap.tailMap(Object)

entrySet

default 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 Object2ReferenceMap<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()

object2ReferenceEntrySet

ObjectSortedSet<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()

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:

object2ReferenceEntrySet in interface Object2ReferenceMap<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 type-specific 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 Object2ReferenceMap<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Returns:

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

See Also:

SortedMap.keySet()

values

ReferenceCollection<V> values()

Returns a type-specific 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 Object2ReferenceMap<K,V>

Specified by:

values in interface SortedMap<K,V>

Returns:

a set view of the values contained in this map.

See Also:

SortedMap.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>

Returns:

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

See Also:

SortedMap.comparator()