الدالة toMap()‎ في Kotlin

تحول الدالة toMap()‎ الكائن المستدعى معها إلى خريطة أو تضيف محتوى ذلك الكائن إلى خريطة موجودة مسبقًا.

البنية العامة

إن استدعيت الدالة toMap()‎ مع مصفوفة أو مجموعة تكرارية أو سلسلة مكونة من أزواج، فستعيد خريطة تحوي كل تلك الأزواج؛ تحافظ الخريطة المُعادة على نفس ترتيب تكرار الخريطة الأصلية:

fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V> 
fun <K, V> Array<out Pair<K, V>>.toMap(): Map<K, V> 
fun <K, V> Sequence<Pair<K, V>>.toMap(): Map<K, V>

وإن استدعيت الدالة toMap()‎ مع مصفوفة أو مجموعة تكرارية أو سلسلة مكونة من أزواج ومع تمرير الخريطة المتغيرة destination كوسيط إليها، فستضيف تلك الأزواج إلى هذه الخريطة المعطاة ثم تعيدها:

fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(
    destination: M
): M
fun <K, V, M : MutableMap<in K, in V>> Array<out Pair<K, V>>.toMap(
    destination: M
): M
fun <K, V, M : MutableMap<in K, in V>> Sequence<Pair<K, V>>.toMap(
    destination: M
): M

وإن استدعيت الدالة toMap()‎ مع خريطة، فستعيد خريطة جديدة للقراء فقط (read-only) تحوي جميع أزواج الخريطة الأصلية المعطاة؛ تحافظ الخريطة المُعادة على نفس ترتيب تكرار الخريطة الأصلية:

fun <K, V> Map<out K, V>.toMap(): Map<K, V>

أمَّا إن استدعيت الدالة toMap()‎ مع خريطة ومع تمرير الخريطة المتغيرة destination كوسيط إليها، فستضيف أزواج تلك الخريطة الأصلية إلى الخريطة destinations المعطاة ثم تعيدها.

fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.toMap(
    destination: M
): M

القيمة المعادة

تُعاد خريطة جديدة تحوي جميع محتويات الكائن المعطى إن لم يمرَّر الوسيط destinations، أو يُعاد الوسيط destination بعد إضافة محتويات الكائن المعطى إليه.

أمثلة

استعمال الدالة ()toMap لتحويل مصفوفة مكونة من أزواج إلى خريطة:

fun main(args: Array<String>) {
    val array = arrayOf(Pair(1, "x"), Pair(2, "y"), Pair(3, "z"))

    println(array.toMap()) // {1=x, 2=y, 3=z}
    println(array.toMap().javaClass.kotlin.qualifiedName) // java.util.LinkedHashMap
}

انظر أيضًا

• الدالة toBooleanArray()‎: تحول المصفوفة العامة (أي من النوع Array<out Boolean>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من القيم المنطقية (من النوع BooleanArray).
• الدالة toByteArray()‎ : تحوِّل المصفوفة العامة (أي من النوع Array<Byte>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من النوع ByteArray.
• الدالة toCharArray()‎: تحول المصفوفة العامة (أي التي من النوع Array<Char>‎) أو المجموعة  التي استُدعيت معها إلى مصفوفة من النوع CharArray.
• الدالة toCollection()‎: تضيف جميع عناصر المصفوفة أو المجموعة التي استُدعيت معها إلى المجموعة المتغيرة (MutableCollection) المُمرّرة إليها.
• الدالة toDoubleArray()‎ : تحول المصفوفة العامة (أي من النوع Array<Double>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من النوع DoubleArray.
• الدالة toFloatArray()‎: تحول المصفوفة العامة (أي من النوع Array<Float>‎) أو المجموعة  التي استُدعيت معها مصفوفة من النوع FloatArray.
• الدالة toHashSet()‎: تعيد كائنًا من النوع HashSet لجميع عناصر المصفوفة أو المجموعة التي استُدعيت معها.
• الدالة toIntArray()‎: تحول المصفوفة العامة (أي من النوع Array<Int>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من النوع IntArray.
• الدالة toList()‎: تحول المصفوفة أو المجموعة التكرارية أو الخريطة التي استُدعيت معها إلى قائمة.
• الدالة toLongArray()‎: تحول المصفوفة العامة (أي من النوع Array<Long>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من النوع LongArray.

• الدالة toMutableList()‎: تحول المصفوف أو المجموعة التي استُدعيت معها إلى قائمة متغيرة. 
• الدالة toMutableSet()‎: تحول المصفوفة أو المجموعة التكرارية التي استُدعيت معها إلى مجموعة من النوع MutableSet.
• الدالة toSet()‎: تحول المصفوفة أو المجموعة التكرارية التي استُدعيت معها إلى مجموعة من النوع Set.
• الدالة toShortArray()‎: تحول المصفوفة العامة (أي من النوع Array<Short>‎) أو المجموعة التي استُدعيت معها إلى مصفوفة من النوع ShortArray.
• الدالة toSortedSet()‎: تحول المصفوفة أو المجموعة التكرارية التي استُدعيت معها إلى مجموعة من النوع SortedSet ثمَّ تعيدها فقط إن لم يمرَّر إليها أي شيء، أو ترتِّبها وفقًا لترتيب معيَّن ثمَّ تعيدها إن مرِّرت إليها دالة مقارنة.

مصادر

• صفحة الدالة toMap()‎ في التوثيق الرسميّ للمكتبة القياسيّة في لغة Kotlin.