الصنف ‎‎Regex‎ في Kotlin

يمثل تعبيرًا نمطيا قابلا للتعديل (immutable regular expression).

الدوال البانية

<init>

ينشِئ التابع Regex()‎ تعبيرًا نمطيًا (regular expression) انطلاقًا من السلسلة النصية المُمرّرة.

الخاصيات

options

تعبر الخاصية options‎ عن مجموعة الخيارات التي استُخدمت في إنشاء التعبير النمطي الذي استُدعيت عبره.

pattern

تعيد الخاصية pattern  السلسلة النصية النمطية (pattern string) التي استُخدمت في إنشاء التعبير النمطي الذي استُدعيت عبره.

الدوال

containsMatchIn

تعيد الدالةcontainsMatchIn()‎ القيمة true إن وَجَد التعبير النمطي الذي استُدعيت عبره على الأقل تطابقا واحدًا في الوسيط المُمرّر.

find

تعيد الدالةfind()‎ فهرس أول مطابقة للتعبير النمطي الذي استُدعيت عبره في الوسيط المُمرّر input،بداية من الفهرس المحدد بالوسيطstartIndex.

findAll

تعيد الدالةfindAll()‎ كل المطابقات للتعبير النمطي الذي استُدعيت عبره في الوسيط المُمرّر input،بداية من الفهرس المحدد بالوسيطstartIndex.

matchEntire

إن كانت جميع حروف الوسيط الممرّر input تطابق التعبير النمطي الذي استُدعيت عبره، فإن الدالةmatchEntire()‎ تعيد نسخة من الصنفMatchResult تحتوي الكائن المُمرّر نفسه، وإلا فستعيد القيمة المعدومة null.

matches

إن كانت جميع حروف الوسيط الممرّر input تطابق التعبير النمطي الذي استُدعيت عبره، فإن الدالةmatches()‎ ستعيد القيمة true، وإلا فستعيدfalse.

replace

تستبدل الدالةreplace()‎ كل المطابقات للتعبير النمطي الذي استُدعيت عبره في الكائن المُمرّر input، بالسلسلة النصية المُمرّرة replacement.

replaceFirst

تستبدل الدالةreplaceFirst()‎ المطابقة الأولى للتعبير النمطي الذي استُدعيت عبره في الكائن المُمرّر input، بالسلسلة النصية المُمرّرةreplacement.

split

تعيد الدالةsplit()‎ لائحة تضم السلاسل النصية الموجودة بين مطابقات التعبير النمطي الذي استُدعيت عبره في الكائن المُمرّر input، الحد الأقصى لعددالسلاسل النصية يحدده الوسيط limit، وقيمته الابتدائية تساوي 0، وتعني لا يوجد عدد أقصى.

toPattern

تعيد الدالةtoPattern()‎ نسخة من الصنف Pattern والتي لها نفس السلسلة النصية النمطية (pattern string) للتعبير النمطي الذي استُدعيت عبره، وهو ما يتيح استخدام Regex حيثما يكون Pattern مطلوبًا.

toString

تعيد الدالةtoString()‎ تمثيلًا نصيًا للتعبير النمطي الذي استُدعيت عبره، أي نمط (Pattern) ذلك التعبير.

الدوال الموروثة (Inherited Functions)

equals

بين الدالة equals()‎ إذا ما كان الكائن المُمرّر إليها يساوي الكائن الذي استدعيت عبره.

hashCode

يعيد التابع hashCode()‎ قيمة الشيفرة hash code الخاصّة بالكائن الذي استُدعي عبره.