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

تحذف الدالة trimMargin()‎ جميع المحارف البيضاء البادئة المتبوعة بقيمة محددة من جميع أسطر السلسلة النصية التي استُدعيت معها، كما تحذف السطر الأول والأخير إن كانا فارغين (blanks)؛ أي مُكوّنان من مسافات بيضاء (whitespaces).

لا تؤثر الدالةُ على الاسطر التي لا تحوي القيمة المحددة بالمعامل marginPrefix المعطى، باستثناء الأسطر البيضاء الأولى والأخيرة.

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

fun String.trimMargin(marginPrefix: String = "|"): String

المعاملات

marginPrefix

سلسلة نصية غير فارغة -أي لا تحوي أية مسافة بيضاة- تستعمل كمحدد للهامش المراد حذفه. القيمة الافتراضية هي: | (محرف الأنبوب [pipe character]).

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

تعاد سلسلة نصية تحوي جميع محتويات السلسلة النصية المعطاة بعد حذف جميع المحارف البيضاء البادئة المتبوعة بالقيمة المحددة بالمعامل marginPrefix من جميع أسطرها، كما تحذف السطر الأول والأخير إن كانا فارغين.

أمثلة

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

import java.util.*

fun main(args: Array<String>) {
    val withoutMargin1 = """ABC
                |123
                |456""".trimMargin()
    println(withoutMargin1) // ABC\n123\n456

    val withoutMargin2 = """
    #XYZ
    #foo
    #bar
""".trimMargin("#")
    println(withoutMargin2) // XYZ\nfoo\nbar
}

انظر أيضًا

• الدالة trim()‎: تحذف المحارف المحققة لشرط معين، أو محارف محددة، أو المسافات الفارغة من بداية ونهاية سلسلة المحارف أو السلسلة النصية التي استُدعيت معها.

• الدالة trimEnd()‎: تحذف المحارف المحققة لشرط معين، أو محارف محددة، أو المسافات الفارغة من نهاية سلسلة المحارف أو السلسلة النصية التي استُدعيت معها.
• الدالة trimStart()‎: تحذف المحارف المحققة لشرط معين، أو محارف محددة، أو المسافات الفارغة من بداية سلسلة المحارف أو السلسلة النصية التي استُدعيت معها.      

• الدالة trimIndent()‎: تبحث عن أقل مسافة بادئة (minimal indent) مشتركة بين جميع أسطر السلسلة النصية التي استُدعيت معها، ثم تحذفها من كل الأسطر، وتحذف أيضًا السطر الأول والأخير إن كانا فارغين.
• الدالة removePrefix()‎: تحذف بادئة معينة من سلسلة من المحارف أو سلسلة نصية.
• الدالة substringBeforeLast()‎: تجلب كل الجزء الواقع قبل آخر ظهور لمحرف أو لسلسلة نصية معينة في سلسلة نصية.  
• الدالة commonSuffixWith()‎: تعيد أطول لاحقة (Suffix) مُشتركة بين سلسلة المحارف التي استُدعيت معها وسلسلة المحارف المُمرّرة إليها.
• الدالة substringBefore()‎: تجلب كل الجزء الواقع قبل أول ظهور لمحرف أو لسلسلة نصية معينة في سلسلة نصية. .  
• الدالة replaceBefore()‎: تبدل سلسلة نصية مكان كل الجزء الواقع قبل أول ظهور لمحرف أو لسلسلة نصية معينة في سلسلة نصية. 

مصادر

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