OptionSetter

public class OptionSetter
extends Object

java.lang.Object
   ↳ com.android.tradefed.config.OptionSetter

מאכלס Option שדות.

יש תמיכה בהגדרת שדות מספריים כמו byte,‏ short,‏ int,‏ long,‏ float ו-double. זה כולל גם גרסאות unboxed וגם גרסאות boxed (לדוגמה, int לעומת Integer). אם יש בעיה בהגדרת הארגומנט כך שיתאים לסוג הרצוי, מוצגת שגיאה ConfigurationException.

שדות של אפשרויות קובץ נתמכים על ידי הוספת ארגומנט המחרוזת לאובייקט File בלי לבדוק אם הקובץ קיים.

יש תמיכה בשדות של אוסף עם פרמטרים, כמו List<File>‎ ו-Set<String>‎, כל עוד סוג הפרמטר נתמך על ידי הפונקציה להגדרת האפשרות. צריך לאתחל את שדה האוסף באמצעות מופע אוסף מתאים.

כל השדות יעברו עיבוד, כולל שדות ציבוריים, מוגנים, שדות גישה שמוגדרים כברירת מחדל (חבילה), שדות פרטיים ושדות שעברו בירושה.

ported from dalvik.runner.OptionParser

מידע נוסף:

סיכום

כיתות מוטמעות

class OptionSetter.Handler<T>

 

class OptionSetter.MapHandler

‫Handler לטיפול בערכים של שדות מיפוי. 

class OptionSetter.OptionFieldsForName

מאגר לרשימת שדות של אפשרויות עם שם נתון. 

ערכים קבועים

char NAMESPACE_SEPARATOR

‫constructors ציבוריים

OptionSetter(Object... optionSources)

יוצרת OptionParser חדש להגדרת השדות @Option של optionSources.

OptionSetter(Collection<Object> optionSources)

יוצרת OptionParser חדש להגדרת השדות @Option של optionSources.

‫methods ציבוריים

static Object getFieldValue(Field field, Object optionObject)

מחזירה את הערך של Field הנתון, ומטפלת בחריגים.

static OptionSetter.Handler<T> getHandler(Type type)
IKeyStoreClient getKeyStore()
static List<Field> getOptionFieldsForClass(Class<?> optionClass)

מקבל רשימה של כל השדות Option (גם אלה שהוגדרו וגם אלה שהועברו בירושה) עבור כיתה נתונה.

String getTypeForOption(String name)

מחזירה מחרוזת שמתארת את סוג השדה עם השם הנתון.

boolean isBooleanOption(String name)
boolean isMapOption(String name)
static boolean setFieldValue(String optionName, Object optionSource, Field field, Object key, Object value, boolean checkOption)

מגדיר את הערך של השדה Option שצוין.

void setKeyStore(IKeyStoreClient keyStore)
List<OptionSetter.FieldDef> setOptionValue(String optionName, String valueText)

הגדרת הערך של אפשרות שאינה מיפוי.

List<OptionSetter.FieldDef> setOptionValue(String optionName, String keyText, String valueText)

מגדיר את הערך של אפשרות.

final Set<File> validateRemoteFilePath(DynamicRemoteFileResolver resolver)

הפונקציה עוברת על כל סוג האפשרויות File ובודקת אם צריך לפתור את הנתיב שלהן.

שיטות מוגנות

Collection<String> getUnsetMandatoryOptions()

הפונקציה מחזירה את השמות של כל Options שסומנו כ-mandatory אבל עדיין לא הוגדרו.

ערכים קבועים

NAMESPACE_SEPARATOR

public static final char NAMESPACE_SEPARATOR

ערך קבוע: 58 (0x0000003a)

‫constructors ציבוריים

OptionSetter

public OptionSetter (Object... optionSources)

יוצרת OptionParser חדש להגדרת השדות @Option של optionSources.

פרמטרים
optionSources Object

הקפצת הודעות שגיאה (throw)
com.android.tradefed.config.ConfigurationException
ConfigurationException

OptionSetter

public OptionSetter (Collection<Object> optionSources)

יוצרת OptionParser חדש להגדרת השדות @Option של optionSources.

פרמטרים
optionSources Collection

הקפצת הודעות שגיאה (throw)
com.android.tradefed.config.ConfigurationException
ConfigurationException

‫methods ציבוריים

getFieldValue

public static Object getFieldValue (Field field, 
                Object optionObject)

מחזירה את הערך של Field הנתון, ומטפלת בחריגים.

פרמטרים
field Field: Field
optionObject ‫Object: Object שממנו יתקבל הערך של השדה.
החזרות
Object הערך של השדה כ-Object או כ-null

getHandler

public static OptionSetter.Handler<T> getHandler (Type type)

פרמטרים
type Type

החזרות
OptionSetter.Handler<T>

הקפצת הודעות שגיאה (throw)
ConfigurationException

getKeyStore

public IKeyStoreClient getKeyStore ()

החזרות
IKeyStoreClient

getOptionFieldsForClass

public static List<Field> getOptionFieldsForClass (Class<?> optionClass)

מקבל רשימה של כל השדות Option (גם אלה שהוגדרו וגם אלה שהועברו בירושה) עבור כיתה נתונה.

פרמטרים
optionClass ‫Class: Class לחיפוש
החזרות
List<Field> Collection שדות עם הערות שנוספו באמצעות Option

getTypeForOption

public String getTypeForOption (String name)

מחזירה מחרוזת שמתארת את סוג השדה עם השם הנתון.

פרמטרים
name ‫String: שם השדה Option
החזרות
String ‫String שמתאר את סוג השדה
הקפצת הודעות שגיאה (throw)
ConfigurationException אם השדה לא נמצא

isBooleanOption

public boolean isBooleanOption (String name)

פרמטרים
name String

החזרות
boolean

הקפצת הודעות שגיאה (throw)
ConfigurationException

isMapOption

public boolean isMapOption (String name)

פרמטרים
name String

החזרות
boolean

הקפצת הודעות שגיאה (throw)
ConfigurationException

setFieldValue

public static boolean setFieldValue (String optionName, 
                Object optionSource, 
                Field field, 
                Object key, 
                Object value, 
                boolean checkOption)

מגדיר את הערך של השדה Option שצוין.

פרמטרים
optionName ‫String: השם שצוין ב-Option
optionSource ‫Object: Object שרוצים להגדיר
field Field: Field
key ‫Object: המפתח של רשומה בשדה Map או MultiMap, או null.
value Object: הערך שרוצים להגדיר
checkOption boolean

החזרות
boolean האם השדה הוגדר.
הקפצת הודעות שגיאה (throw)
com.android.tradefed.config.ConfigurationException
ConfigurationException

מידע נוסף:

setKeyStore

public void setKeyStore (IKeyStoreClient keyStore)

פרמטרים
keyStore IKeyStoreClient

setOptionValue

public List<OptionSetter.FieldDef> setOptionValue (String optionName, 
                String valueText)

הגדרת הערך של אפשרות שאינה מיפוי.

פרמטרים
optionName ‫String: השם של האפשרות שרוצים להגדיר
valueText ‫String: הערך
החזרות
List<OptionSetter.FieldDef> רשימה של ERROR(FieldDef/com.android.tradefed.config.OptionSetter.FieldDef FieldDef)s שמתאימים לכל שדה אובייקט ששונה.
הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן למצוא את Option או אם valueText הוא מסוג שגוי

setOptionValue

public List<OptionSetter.FieldDef> setOptionValue (String optionName, 
                String keyText, 
                String valueText)

מגדיר את הערך של אפשרות.

פרמטרים
optionName ‫String: השם של האפשרות שרוצים להגדיר
keyText ‫String: המפתח לאפשרויות המפה, או null.
valueText ‫String: הערך
החזרות
List<OptionSetter.FieldDef> רשימה של ERROR(FieldDef/com.android.tradefed.config.OptionSetter.FieldDef FieldDef)s שמתאימים לכל שדה אובייקט ששונה.
הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן למצוא את Option או אם valueText הוא מסוג שגוי

validateRemoteFilePath

public final Set<File> validateRemoteFilePath (DynamicRemoteFileResolver resolver)

הפונקציה עוברת על כל סוג האפשרויות File ובודקת אם צריך לפתור את הנתיב שלהן.

פרמטרים
resolver ‫DynamicRemoteFileResolver: DynamicRemoteFileResolver שמשמש לפתרון הבעיות בקבצים.
החזרות
Set<File> רשימת File שנפתרו בדרך הזו.
הקפצת הודעות שגיאה (throw)
com.android.tradefed.build.BuildRetrievalError
BuildRetrievalError

שיטות מוגנות

getUnsetMandatoryOptions

protected Collection<String> getUnsetMandatoryOptions ()

הפונקציה מחזירה את השמות של כל Options שסומנו כ-mandatory אבל עדיין לא הוגדרו.

החזרות
Collection<String> ‫Collection של Strings שמכיל את השמות (הלא מוסמכים) של אפשרויות חובה שלא הוגדרו.
הקפצת הודעות שגיאה (throw)
ConfigurationException אם שדה שצריך לבדוק לא נגיש