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

القيمة الثابتة: 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 باستخدام الخيار --help في سطر الأمر.

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

المرتجعات
String

requiredForRerun

public boolean requiredForRerun ()

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

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

المرتجعات
boolean

shortName

public char shortName ()

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

المرتجعات
char

updateRule

public OptionUpdateRule updateRule ()

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

المرتجعات
OptionUpdateRule