خيار
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
القيمة الثابتة: 48 (0x00000030)
الأساليب العامة
وصف
public String description ()
وصف سهل الاستخدام للخيار.
| عائدات | |
|---|---|
String | |
أهمية
public Option.Importance importance ()
أهمية الخيار.
سيتم عرض خيار يعتبر "مهمًا" في مخرجات المساعدة المختصرة. لن يتم عرض التعليمات الخاصة بالخيار غير المهم إلا في نص المساعدة الكامل.
| عائدات | |
|---|---|
Option.Importance | |
isTimeVal
public boolean isTimeVal ()
ما إذا كان الخيار يمثل قيمة زمنية.
إذا كانت هذه قيمة زمنية، فسيتم تحليل اللواحق الخاصة بالوقت. الميدانlong أو Long حتى تكون هذه العلامة صالحة. سيتم طرح ConfigurationException بخلاف ذلك.
الوحدة الافتراضية هي ملي. سيقبل إطار التكوين s للثواني (1000 مللي)، m للدقائق (60 ثانية)، أو h للساعات (60 دقيقة)، أو d للأيام (24 ساعة).
يمكن خلط الوحدات ومطابقتها، طالما أن كل وحدة تظهر مرة واحدة على الأكثر، وطالما أن جميع الوحدات التي تظهر مدرجة بترتيب تنازلي على المقياس. لذلك، على سبيل المثال، قد يظهر h فقط قبل m ، وقد يظهر فقط بعد d . وكمثال محدد، ستكون "1d2h3m4s5ms" قيمة زمنية صالحة، كما هو الحال مع "4" أو "4ms". يتم تجاهل كافة المسافات البيضاء المضمنة.
| عائدات | |
|---|---|
boolean | |
إلزامي
public boolean mandatory ()
وسواء كان الخيار إلزاميا أم اختياريا.
سيطرح إطار التكوين ConfigurationException إذا كان أي مما يلي صحيحًا بالنسبة لحقل إلزامي بعد تحليل الخيارات من جميع المصادر:
- الحقل
null. - الحقل عبارة عن
ERROR(/Collection)فارغ.
| عائدات | |
|---|---|
boolean | |
اسم
public String name ()
الاسم الفريد الإلزامي لهذا الخيار.
سيتم تعيين هذا إلى وسيطة سطر الأوامر مسبوقة بحرفين "-". على سبيل المثال، سيتم تحديد Option بالاسم "مساعدة" باستخدام "--مساعدة" في سطر الأوامر.
لا يجوز أن تحتوي الأسماء على نقطتين، على سبيل المثال ':'.
| عائدات | |
|---|---|
String | |
RequiredForRerun
public boolean requiredForRerun ()
ما إذا كان الخيار مطلوبًا لتجميع التعليمات لإعادة تشغيل الاختبار.
قد يحاول مُبلغ النتائج تجميع تعليمات حول كيفية إعادة تشغيل الاختبار وتضمين الرسالة في النتيجة. يجب أن تتضمن التعليمات جميع الخيارات التي تنطبق على إعادة الاختبار. يتم استخدام هذه السمة للإشارة إلى ما إذا كان سيتم تضمين الخيار في هذه التعليمات.
| عائدات | |
|---|---|
boolean | |
اسم قصير
public char shortName ()
اسم مختصر اختياري للخيار. سيتم تعيين هذا إلى وسيطة سطر الأوامر مسبوقة بـ "-" واحد. على سبيل المثال "-h" حيث h = shortName. "0" محجوز ليعني أن الخيار ليس له اسم قصير.
| عائدات | |
|---|---|
char | |
updateRule
public OptionUpdateRule updateRule ()
يتحكم في السلوك عند تحديد خيار عدة مرات. لاحظ أنه يتم تجاهل هذه القاعدة تمامًا بالنسبة للخيارات التي تكون ERROR(/Collection) s أو ERROR(/Map) s.
| عائدات | |
|---|---|
OptionUpdateRule | |