אפשרות
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 לשניות (1,000 אלפיות שנייה), את הערך 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' יצוין באמצעות '--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 |
|