الدالة String.compareTo()‎ في Kotlin

توازن الدالة compareTo()‎ بين سلسلتين نصيتين معجميًّا (lexicographically)، مع إمكانية تجاهل حالة الأحرف.

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

fun String.compareTo(
    other: String, 
    ignoreCase: Boolean = false
): Int

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

المعاملات

other

السلسلة النصية المراد موازنتها مع السلسلة النصية المعطاة.

ignoreCase

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

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

تعاد القيمة 0 إن كانت السلسلتان النصيتان متساويتن، أو قيمة موجبة إن كانت السلسلة النصية الأولى أكبر من السلسلة النصية الثانية (أي السلسلة ohter)، أو قيمة سالبة إن كانت السلسلة النصية الثانية أكبر من السلسلة النصية الأولى.

أمثلة

استعمال الدالة ()compareTo للموازنة بين سلسلتين نصيتين:

fun main(args: Array<String>) {
    val str = "abcd"

    println(str.compareTo("abch")) // => -4 
}

انظر أيضًا

• الدالة contentEquals()‎: تتحقق من تساوي محتوى السلسلة النصية التي استُدعيت معها مع محتوى سلسلة المحارف أو الكائن StringBuffer المُمرّر إليها.  
• الدالة contains()‎ إن كانت سلسلة المحارف التي استُدعيت معها تحوي المحرف أو سلسلة المحارف المُمرّرة إليها.
• الدالة commonPrefixWith()‎: تعيد أطول بادئة (prefix) مُشتركة بين سلسلة المحارف التي استُدعيت معها وسلسلة المحارف المُمرّرة إليها.

مصادر

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