گزینه

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 ()

وقتی یک گزینه چندین بار مشخص می‌شود، رفتار را کنترل می‌کند.

ثابت‌ها

نام_کوتاه_نیست

public static final char NO_SHORT_NAME

مقدار ثابت: ۴۸ (۰x۰۰۰۰۰۳۰)

روش‌های عمومی

توضیحات

public String description ()

توضیحات کاربرپسند از گزینه.

بازگشت‌ها
String

اهمیت

public Option.Importance importance ()

اهمیت گزینه.

گزینه‌ای که «مهم» تلقی شود، در خروجی راهنمای مختصر نمایش داده می‌شود. راهنمای گزینه‌ای که بی‌اهمیت باشد، فقط در متن راهنمای کامل نمایش داده می‌شود.

بازگشت‌ها
Option.Importance

isTimeVal

public boolean isTimeVal ()

اینکه آیا آپشن نشان دهنده یک مقدار زمانی است یا خیر.

اگر این یک مقدار زمانی باشد، پسوندهای مختص به زمان تجزیه خواهند شد. فیلد باید برای معتبر بودن این پرچم، باید مقدار long یا Long باشد. در غیر این صورت، خطای ConfigurationException صادر خواهد شد.

واحد پیش‌فرض millis است. چارچوب پیکربندی 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

نام کوتاه

public char shortName ()

نام اختصاری اختیاری برای گزینه. این به یک آرگومان خط فرمان با پیشوند '-' نگاشت می‌شود. مثلاً "-h" که در آن h = shortName است. '0' رزرو شده است تا گزینه shortName نداشته باشد.

بازگشت‌ها
char

قانون به‌روزرسانی

public OptionUpdateRule updateRule ()

رفتار را هنگامی که یک گزینه چندین بار مشخص شده است کنترل می‌کند. توجه داشته باشید که این قانون برای گزینه‌هایی که Collection یا Map هستند کاملاً نادیده گرفته می‌شود.

بازگشت‌ها
OptionUpdateRule