אפשרות
public
abstract
@interface
Option
implements
Annotation
| com.android.tradefed.config.Option |
הערה שמציינת ששדה מייצג אפשרות של IConfiguration.
סיכום
ערכים קבועים | |
|---|---|
char |
NO_SHORT_NAME
|
methods ציבוריים | |
|---|---|
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)
methods ציבוריים
תיאור
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. - השדה הוא
Collectionריק.
| החזרות | |
|---|---|
boolean |
|
שם
public String name ()
השם הייחודי של האפשרות הזו (חובה).
המיפוי הזה יתבצע לארגומנט של שורת פקודה עם הקידומת '--'.
לדוגמה, אם רוצים לציין Option עם השם help, צריך להשתמש ב-'--help' בשורת הפקודה.
השמות לא יכולים להכיל נקודתיים, לדוגמה ':'.
| החזרות | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
האם האפשרות נדרשת כדי לקמפל הוראה להרצת בדיקה מחדש.
יכול להיות שכלי הדיווח על התוצאות ינסה ליצור הוראות להרצה חוזרת של בדיקה ויכלול את ההודעה בתוצאה. ההוראה צריכה לכלול את כל האפשרויות שרלוונטיות להרצה חוזרת של בדיקה. המאפיין הזה משמש כדי לציין אם האפשרות תיכלל בהוראה כזו.
| החזרות | |
|---|---|
boolean |
|
שם מקוצר
public char shortName ()
שם מקוצר אופציונלי לאפשרות. המיפוי יהיה לארגומנט של שורת פקודה עם קידומת של מקף יחיד '-'. לדוגמה, "-h" כאשר h = shortName. הערך '0' שמור לציון האפשרות שאין לה shortName.
| החזרות | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
קובעת את ההתנהגות כשמציינים אפשרות כמה פעמים. הערה: המערכת מתעלמת לחלוטין מהכלל הזה לגבי אפשרויות שהן Collections או Maps.
| החזרות | |
|---|---|
OptionUpdateRule |
|