azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify toSortedMap and sortedMapOf docs (KT-30100)

Browse Source 
Remove the note about iteration order so that toSortedMap is not misused
for sorting map entires with the comparator inconsistent with key equality.
This commit is contained in:
Ilya Gorbunov
2019-03-15 20:01:01 +03:00
parent c650206f54
commit 8021f9c4af
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/jvm/src/kotlin/collections/MapsJVM.kt
+10 -3
View File
@@ -45,15 +45,20 @@ public inline fun <K, V> ConcurrentMap<K, V>.getOrPut(key: K, defaultValue: () -
/**
* Converts this [Map] to a [SortedMap] so iteration order will be in key order.
* Converts this [Map] to a [SortedMap]. The resulting [SortedMap] determines the equality and order of keys according to their natural sorting order.
*
* Note that if the natural sorting order of keys considers any two keys of this map equal
* (this could happen if the equality of keys according to [Comparable.compareTo] is inconsistent with the equality according to [Any.equals]),
* only the value associated with the last of them gets into the resulting map.
*
* @sample samples.collections.Maps.Transformations.mapToSortedMap
*/
public fun <K : Comparable<K>, V> Map<out K, V>.toSortedMap(): SortedMap<K, V> = TreeMap(this)
/**
* Converts this [Map] to a [SortedMap] using the given [comparator] so that iteration order will be in the order
* defined by the comparator.
* Converts this [Map] to a [SortedMap]. The resulting [SortedMap] determines the equality and order of keys according to the sorting order provided by the given [comparator].
*
* Note that if the `comparator` considers any two keys of this map equal, only the value associated with the last of them gets into the resulting map.
*
* @sample samples.collections.Maps.Transformations.mapToSortedMapWithComparator
*/
@@ -64,6 +69,8 @@ public fun <K, V> Map<out K, V>.toSortedMap(comparator: Comparator<in K>): Sorte
* Returns a new [SortedMap] with the specified contents, given as a list of pairs
* where the first value is the key and the second is the value.
*
* The resulting [SortedMap] determines the equality and order of keys according to their natural sorting order.
*
* @sample samples.collections.Maps.Instantiation.sortedMapFromPairs
*/
public fun <K : Comparable<K>, V> sortedMapOf(vararg pairs: Pair<K, V>): SortedMap<K, V> =