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

تجلب الدالة firstOrNull()‎ أول عنصر من عناصر المصفوفة أو المجموعة التي استُدعيت معها إن لم يُمرَّر إليها أي شيء، أو أول عنصر يحقق شرطًا معيَّنًا في حال تمرير دالة منطقية إليها.

إن كانت المصفوفة أو المجموعة التي استُدعيت الدالة first()‎ معها فارغة أو لم يكن هناك أي عنصر يحقق الدالة المنطقية الممرَّرة إليها، فستعيد الدالة القيمة null.

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

يمكن استدعاء الدالة firstOrNull()‎ بدون تمرير أية معاملات:

fun <T> Array<out T>.firstOrNull(): T? 
fun ByteArray.firstOrNull(): Byte? 
fun ShortArray.firstOrNull(): Short? 
fun IntArray.firstOrNull(): Int? 
fun LongArray.firstOrNull(): Long? 
fun FloatArray.firstOrNull(): Float? 
fun DoubleArray.firstOrNull(): Double? 
fun BooleanArray.firstOrNull(): Boolean? 
fun CharArray.firstOrNull(): Char?

ويمكن أيضًا استدعاء هذه الدالة مع تمرير دالة تمثِّل شرطًا منطقيًّا إليها:

inline fun <T> Array<out T>.firstOrNull(
    predicate: (T) -> Boolean
): T? 
inline fun ByteArray.firstOrNull(
    predicate: (Byte) -> Boolean
): Byte? 
inline fun ShortArray.firstOrNull(
    predicate: (Short) -> Boolean
): Short? 
inline fun IntArray.firstOrNull(
    predicate: (Int) -> Boolean
): Int? 
inline fun LongArray.firstOrNull(
    predicate: (Long) -> Boolean
): Long? 
inline fun FloatArray.firstOrNull(
    predicate: (Float) -> Boolean
): Float? 
inline fun DoubleArray.firstOrNull(
    predicate: (Double) -> Boolean
): Double? 
inline fun BooleanArray.firstOrNull(
    predicate: (Boolean) -> Boolean
): Boolean?
inline fun CharArray.firstOrNull(
    predicate: (Char) -> Boolean
): Char? 
inline fun <T> Iterable<T>.firstOrNull(
    predicate: (T) -> Boolean
): T?

ويمكن استعمال الدالة أيضًا مع القوائم:

fun <T> Iterable<T>.firstOrNull(): T? 
fun <T> List<T>.firstOrNull(): T?

وجود الكلمة المفتاحية inline يدل على أنَّ هذه الدالة مباشرة (للمزيد من التفاصيل، راجع صفحة الدوال المباشرة (inline functions)).

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

يُعاد أول عنصر من عناصر المصفوفة أو المجموعة المعطاة إن لم يُمرَّر إلى الدالة أي معامل، أو أول عنصر يحقق شرطًا معيَّنًا في حال تمرير دالة منطقية كمعامل، أو القيمة nulll إن كانت المصفوفة أو المجموعة المعطاة فارغة أو لم يكن هناك أي عنصر يحقق ذلك الشرط المعطى.

أمثلة

استخدام الدالة ()firstOrNull مع المصفوفات: عدم تمرير أي معامل

تعرف الشيفرة الآتية مصفوفة باسم array باستخدام الدالة ()arrayOf، ثمَّ تستخدم الدالة ()firstOrNull لجلب العنصر الأول من تلك المصفوفة:

fun main(args: Array<String>) {
    val array = arrayOf(9, 2, 3, 5, 0, 6)

    println(array.firstOrNull()) // 9
}

استخدام الدالة ()firstOrNull مع المصفوفات: تمرير معامل

تعرف الشيفرة الآتية مصفوفة باسم array باستخدام الدالة ()arrayOf، ثمَّ تستخدم الدالة ()first لجلب أول عنصر من تلك المصفوفة شرط أن تكون قيمته سالبة:

fun main(args: Array<String>) {
    val array = arrayOf(9, 2, 3, 8, 5, 6)
    val predicate: (Int) -> Boolean = { it < 0 }

    println(array.firstOrNull(predicate)) // null
}

انظر أيضًا

• الدالة lastOrNull()‎: تجلب آخر عنصر من عناصر المصفوفة أو المجموعة التي استُدعيت معها إن لم يُمرَّر إليها أي شيء، أو آخر عنصر يحقق شرطًا معيَّنًا في حال تمرير دالة منطقية إليها.
• الدالة first()‎: أول عنصر من عناصر المصفوفة أو المجموعة التي استُدعيت معها إن لم يمرر إليها أي شيء، أو أول عنصر يحق شرطًا معيَّنًا في حال تمرير دالة منطقية إليها. 
• الدالة findLast()‎: تبحث على عنصر محدَّد ضمن عناصر المصفوفة أو المجموعة التي استُدعيت معها ثمَّ تعيد آخر ظهور له.
• الدالة filterTo()‎: تشبه الدالة filter()‎ في جميع النواحي باستثناء أنها تضيف الناتج إلى المعامل المُمرَّر إليها.
• الدالة filterNotNull()‎: تعيد جميع عناصر المصفوفة أو المجموعة المعطاة باستثناء تلك ذات القيمة null.

مصادر

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