Option

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


تُستخدم هذه السمة للإشارة إلى حقل يمثّل خيار IConfiguration.

ملخّص

الثوابت

char NO_SHORT_NAME

الإجراءات العامة

String description()

وصف سهل الاستخدام للخيار

Option.Importance importance()

أهمية الخيار

boolean isTimeVal()

ما إذا كان الخيار يمثّل قيمة وقت

boolean mandatory()

ما إذا كان الخيار إلزاميًا أو اختياريًا

String name()

الاسم الفريد الإلزامي لهذا الخيار

boolean requiredForRerun()

ما إذا كان الخيار مطلوبًا لتجميع التعليمات لإعادة تشغيل اختبار

char shortName()

الاسم المختصر الاختياري للخيار

OptionUpdateRule updateRule()

يتحكّم هذا الخيار في السلوك عند تحديد خيار عدة مرات.

الثوابت

NO_SHORT_NAME

public static final char NO_SHORT_NAME

Constant Value: 48 (0x00000030)

الإجراءات العامة

الوصف

public String description ()

وصف سهل الاستخدام للخيار

المرتجعات
String

الأهمية

public Option.Importance importance ()

أهمية الخيار

سيظهر الخيار الذي يُعتبر "مهمًا" في ناتج التعليمات المختصرة. ولن تظهر التعليمات الخاصة بخيار غير مهم إلا في نص التعليمات الكامل.

المرتجعات
Option.Importance

isTimeVal

public boolean isTimeVal ()

ما إذا كان الخيار يمثّل قيمة وقت

إذا كانت هذه قيمة وقت، سيتم تحليل اللاحقات الخاصة بالوقت. يجب أن يكون الحقل MUST long أو Long لكي يكون هذا العَلم صالحًا. سيتم طرح ConfigurationException بخلاف ذلك.

الوحدة التلقائية هي الملّي ثانية. سيقبل إطار العمل s للثواني (1000 ملّي ثانية)، أو m للدقائق (60 ثانية)، أو h للساعات (60 دقيقة)، أو d للأيام (24 ساعة).

يمكن دمج الوحدات ومطابقتها، طالما أنّ كل وحدة تظهر مرة واحدة على الأكثر، وطالما أنّ جميع الوحدات التي تظهر مدرَجة بترتيب تنازلي حسب المقياس. على سبيل المثال، لا يمكن أن تظهر h إلا قبل m، ولا يمكن أن تظهر إلا بعد d. كمثال محدّد ، ستكون "1d2h3m4s5ms" قيمة وقت صالحة، وكذلك "4" أو "4ms". يتم تجاهل جميع المسافات البيضاء المضمّنة.

المرتجعات
boolean

إلزامي

public boolean mandatory ()

ما إذا كان الخيار إلزاميًا أو اختياريًا

سيطرح إطار عمل الإعدادات ConfigurationException إذا كان أيٌّ من الـ التالي صحيحًا في حقل إلزامي بعد تحليل الخيارات من جميع المصادر:

  • الحقل هو null.
  • الحقل هو Collection فارغ.

المرتجعات
boolean

الاسم

public String name ()

الاسم الفريد الإلزامي لهذا الخيار

سيتم ربط هذا الاسم بوسيطة سطر أوامر مسبوقة بعلامتَي شرطة (`--`). على سبيل المثال، سيتم تحديد Option باسم "help" باستخدام ‎`--help` على سطر الأوامر.

لا يمكن أن تحتوي الأسماء على نقطتَين رأسيتَين، مثل ":".

المرتجعات
String

requiredForRerun

public boolean requiredForRerun ()

ما إذا كان الخيار مطلوبًا لتجميع التعليمات لإعادة تشغيل اختبار

قد يحاول برنامج الإبلاغ عن النتائج تجميع التعليمات حول كيفية إعادة تشغيل اختبار وتضمين الـ رسالة في النتيجة. يجب أن تتضمّن التعليمات جميع الخيارات المنطبقة على إعادة تشغيل الاختبار. تُستخدم هذه السمة للإشارة إلى ما إذا كان يجب تضمين الخيار في هذه التعليمات.

المرتجعات
boolean

shortName

public char shortName ()

الاسم المختصر الاختياري للخيار سيتم ربط هذا الاسم بوسيطة سطر أوامر مسبوقة بعلامة شرطة واحدة (`-`). على سبيل المثال، ‎`-h` حيث h = shortName. الرقم "0" محجوز للإشارة إلى أنّ الخيار ليس له اسم مختصر.

المرتجعات
char

updateRule

public OptionUpdateRule updateRule ()

يتحكّم هذا الخيار في السلوك عند تحديد خيار عدة مرات. يُرجى العِلم أنّ هذه القاعدة يتم تجاهلها تمامًا بالنسبة إلى الخيارات التي تكون Collection أو Map.

المرتجعات
OptionUpdateRule