Kotlin/kotlin.text/startsWith

تتحقق الدالة startsWith()‎ إن كانت السلسلة النصية أو سلسلة المحارف التي استُدعيت معها تبدأ بمحرف معين أو لاحقة معينة.  

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

fun String.startsWith(
    prefix: String, 
    ignoreCase: Boolean = false
): Boolean

fun CharSequence.startsWith(
    prefix: CharSequence, 
    ignoreCase: Boolean = false
): Boolean

تتحقق الدالة startsWith()‎ إن كانت السلسلة النصية أو سلسلة المحارف التي استُدعيت معها تبدأ بالبادئة prefix.  

fun String.startsWith(
    prefix: String, 
    startIndex: Int, 
    ignoreCase: Boolean = false
): Boolean

fun CharSequence.startsWith(
    prefix: CharSequence, 
    startIndex: Int, 
    ignoreCase: Boolean = false
): Boolean

تتحقق الدالة startsWith()‎ إن كانت السلسلة النصية أو سلسلة المحارف التي استُدعيت معها تحتوي على البادئة prefix وذلك بدءًا من المحرف ذي الفهرس startIndex. 

fun CharSequence.startsWith(
    char: Char, 
    ignoreCase: Boolean = false
): Boolean

تتحقق الدالة startsWith()‎ إن كانت سلسلة المحارف التي استُدعيت معها تبدأ بالمحرف char.  

المعاملات

prefix

سلسلة نصية أو سلسلة من المحارف تمثل البادئة التي يراد التحقق من أنَّ السلسلة النصية أو سلسلة المحارف المعطاة تبدأ بها.

char

المحرف الذي يراد التأكد من وجوده في بداية سلسلة المحارف المعطاة.

startIndex

عدد صحيح يمثل فهرس العنصر الذي يراد بدء عملية البحث عن البادئة prefix عنده.

ignoreCase

قيمة منطقية تحدد إن كان يراد تجاهل حالة المحارف أم لا أثناء الموازنة. القيمة الافتراضية هي: false أي أخذ حالة الحروف بالحسبان.

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

تعاد القيمة true إن كانت السلسلة النصية المعطاة تبدأ بالبادئة prefix أو كانت سلسلة المحارف المعطاة تبدأ بالبادئة prefix أو بالمحرف char سواءً من بداية السلسلة النصية أو سلسلة المحارف أو من بداية المحرف ذي الفهرس startIndex فيهما. خلا ذلك، تعاد القيمة false. 

أمثلة

مثالٌ على استعمال الدالة ()startsWith:

fun main(args: Array<String>) {
    val str = "wiki.hsoub.com"

    println(str.startsWith("wiki")) // true
    println(str.startsWith("www")) // false
}

انظر أيضًا

• الدالة endsWith()‎: تتحقق إن كانت السلسلة النصية أو سلسلة المحارف التي استُدعيت معها تنتهي بمحرف معين أو لاحقة معينة.
• الدالة commonPrefixWith()‎: تعيد أطول بادئة (prefix) مُشتركة بين سلسلة المحارف التي استُدعيت معها وسلسلة المحارف المُمرّرة إليها.
• الدالة compareTo()‎: توازن بين سلسلتين نصيتين معجميًّا (lexicographically)، مع إمكانية تجاهل حالة الأحرف.

• الدالة equals()‎: تتحقق من تساوي السلسلة النصية أو المحرف الذي استُدعي معها مع السلسلة النصية أو المحرف المُمرّر إليها مع إمكانية تجاهل حالة المحارف.

مصادر

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