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

من موسوعة حسوب

تنسِّق الدالة format()‎ سلسلة نصية وفقًا لقيمة المعاملات التي تمرر إليها.

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

inline fun String.format(vararg args: Any?): String

بيئة التشغيل المطلوبة: JVM. تستعمل format()‎ السلسلة النصية التي استُدعيت معها كسلسلة تنسيق نصية (format string) وتعيد سلسلة نصية ناتجة عن تعويض الوسائط args المعطاة وباستخدام الإعدادات الافتراضية للمحلية (locale).

inline fun String.Companion.format(
    format: String, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM. تستعمل الدالة format()‎ السلسلة النصية format المُمرّرة كسلسلة تنسيق نصية وتعيد سلسلة نصية ناتجة عن تعويض الوسائط args المعطاة وباستخدام الإعدادات الافتراضية للمحلية (locale).

inline fun String.format(
    locale: Locale, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM. تستعمل الدالة format()‎ السلسلة النصية التي استُدعيت معها كسلسلة تنسيق نصية وتعيد سلسلة نصية ناتجة عن تعويض الوسائط args المعطاة وباستخدام الإعدادات locale الممررة للمحلية (locale).

inline fun String.Companion.format(
    locale: Locale, 
    format: String, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM.

تستعمل الدالة format()‎ السلسلة النصية format الممررة كسلسلة تنسيق نصية وتعيد سلسلة نصية ناتجة عن تعويض الوسائط args المعطاة وباستخدام الإعدادات locale الممررة للمحلية (locale).

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

المعاملات

args

الوسائط المراد استعمالها في علمية التنسيق.

format

سلسلة التنسيق النصية.

locale

إعدادات المحلية المراد استعمالها في عملية التنسيق.

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

تعاد سلسلة نصية.

أمثلة

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

fun main(args: Array<String>) {
    var formatTemplate = "%-2s\t%s"

    println(formatTemplate.format("%b", "hsoub")) // %b	hsoub
}

مصادر