אפשרות
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' או 4 אלפיות השנייה. כולם מוטמעים
הרווח הלבן נמחק.
החזרות | |
---|---|
boolean |
חובה
public boolean mandatory ()
האם האפשרות היא חובה או אופציונלית.
מסגרת ההגדרה תקפיץ הודעת ConfigurationException
אם אחד או יותר
הערך הבא מתקיים בשדה חובה אחרי שהאפשרויות שנותחו מכל המקורות:
- בשדה הוא
null
. - השדה
ERROR(/Collection)
ריק.
החזרות | |
---|---|
boolean |
שם
public String name ()
השם הייחודי הנדרש לאפשרות הזו.
הפעולה הזו תמפה לארגומנט של שורת פקודה עם הקידומת שני '-' תווים.
לדוגמה, Option
בשם 'help' יצוין '--עזרה' ב
בשורת הפקודה.
שמות לא יכולים להכיל נקודתיים, למשל ':'.
החזרות | |
---|---|
String |
נדרשForRerun
public boolean requiredForRerun ()
האם יש צורך באפשרות להדר הוראות להרצת בדיקה מחדש.
כתב התוצאות עשוי לנסות לאסוף הוראה להריץ בדיקה מחדש, ולכלול את בתוצאה. ההוראה תכלול את כל האפשרויות שרלוונטיות לבדיקה בשידור חוזר. מאפיין זה משמש כדי לציין אם האפשרות תיכלל הוראות להתאמה אישית.
החזרות | |
---|---|
boolean |
שם קצר
public char shortName ()
אפשרות לשם מקוצר של האפשרות. הפעולה הזו תמפה לארגומנט של שורת פקודה עם קידומת '-' יחיד. לדוגמה " -h" כאשר h = ShortName. 0 שמורה לאפשרות שאין שם מקוצר.
החזרות | |
---|---|
char |
עדכוןכלל
public OptionUpdateRule updateRule ()
המדיניות הזו קובעת את ההתנהגות אם אפשרות מסוימת מצוינת כמה פעמים. שימו לב שהכלל הזה
המערכת מתעלמת ממנו לגמרי אם האפשרויות הן ERROR(/Collection)
או ERROR(/Map)
.
החזרות | |
---|---|
OptionUpdateRule |