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
ערך קבוע: 48 (0x00000030)
public String description ()
תיאור ידידותי למשתמש של האפשרות.
החזרות | |
---|---|
String |
public Option.Importance importance ()
חשיבות האופציה.
אפשרות שנחשבת כ'חשובה' תוצג בפלט העזרה המקוצר. עזרה עבור אפשרות לא חשובה תוצג רק בטקסט העזרה המלא.
החזרות | |
---|---|
Option.Importance |
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
בשם 'עזרה' תצוין עם '--help' בשורת הפקודה.
שמות אינם יכולים להכיל נקודתיים, למשל ':'.
החזרות | |
---|---|
String |
public boolean requiredForRerun ()
האם יש צורך באפשרות לקמפל הוראה להפעלה חוזרת של בדיקה.
כתב התוצאות עשוי לנסות להרכיב הוראות כיצד להפעיל מחדש בדיקה ולכלול את ההודעה בתוצאה. ההוראה תכלול את כל האפשרויות החלות על שידור חוזר של בדיקה. תכונה זו משמשת כדי לציין אם האפשרות תיכלל בהוראה כזו.
החזרות | |
---|---|
boolean |
public char shortName ()
שם מקוצר אופציונלי לאופציה. זה ימפה לארגומנט שורת פקודה עם קידומת '-' בודד. למשל "-h" כאשר h = shortName. '0' שמור משמע שלאפשרות אין shortName.
החזרות | |
---|---|
char |
public OptionUpdateRule updateRule ()
שולט בהתנהגות כאשר אפשרות מצוינת מספר פעמים. שים לב שהכלל הזה מתעלם לחלוטין עבור אפשרויות שהן ERROR(/Collection)
s או ERROR(/Map)
s.
החזרות | |
---|---|
OptionUpdateRule |