خيار

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 إذا كان أي مما يلي ينطبق على حقل إلزامي بعد تحليل الخيارات من جميع المصادر:

عائدات
boolean

اسم

public String name ()

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

سيؤدي هذا إلى تعيين وسيطة سطر أوامر مسبوقة بحرفين "-". على سبيل المثال ، سيتم تحديد Option باسم "مساعدة" باستخدام "--help" في سطر الأوامر.

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

عائدات
String

مطلوب لإعادة التشغيل

public boolean requiredForRerun ()

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

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

عائدات
boolean

اسم قصير

public char shortName ()

اسم مختصر اختياري للخيار. سيؤدي هذا إلى تعيين وسيطة سطر أوامر مسبوقة بـ "-" واحد. على سبيل المثال "-h" حيث h = shortName. "0" محجوز ليعني أن الخيار ليس له اسم مختصر.

عائدات
char

تحديث القاعدة

public OptionUpdateRule updateRule ()

يتحكم في السلوك عند تحديد خيار عدة مرات. لاحظ أنه يتم تجاهل هذه القاعدة تمامًا للخيارات التي تكون ERROR(/Collection) s أو ERROR(/Map) s.

عائدات
OptionUpdateRule