IConfigurationFactory
public
interface
IConfigurationFactory
| com.android.tradefed.config.IConfigurationFactory |
פקטורי ליצירת IConfiguration
סיכום
שיטות ציבוריות | |
|---|---|
abstract
IConfiguration
|
createConfigurationFromArgs(String[] args,
יוצרים את |
abstract
IConfiguration
|
createConfigurationFromArgs(String[] args)
שיטה נוחה שמפעילה את |
abstract
IConfiguration
|
createConfigurationFromArgs(String[] args,
יצירת |
abstract
IGlobalConfiguration
|
createGlobalConfigurationFromArgs(String[] args,
יצירת |
abstract
IConfiguration
|
createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient,
יצירת הגדרה אישית שמכילה רק קבוצה של אובייקטים שנבחרו. |
abstract
void
|
dumpConfig(String configName, PrintStream out)
יצירת גרסת dump של תוכן ההגדרות ב- |
abstract
|
getConfigList()
הפונקציה מחזירה את רשימת השמות של כל הגדרות ה-config שנמצאות בקובצי ה-JAR ב-classpath. |
abstract
|
getConfigList(String subPath, boolean loadFromEnv)
וריאציה של |
abstract
void
|
printHelp(PrintStream out)
הדפסות עוזרות להפיק את הפלט של המפעל הזה. |
abstract
void
|
printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)
הדפסת פלט עזרה של
אם 'args' מפנה לתצורה ידועה, ייווצר אובייקט |
שיטות ציבוריות
createConfigurationFromArgs
public abstract IConfiguration createConfigurationFromArgs (String[] args,unconsumedArgs)
יוצרים את IConfiguration מארגומנטים בשורת הפקודה.
הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנית או נתיב לקובץ XML של תצורה.
| פרמטרים | |
|---|---|
args |
String: הארגומנטים בשורת הפקודה |
unconsumedArgs |
: רשימה שתתמלא בארגומנטים שלא נצרכו על ידי האובייקטים שמשויכים לתצורה שצוינה. אם הערך הוא null, ההטמעה תזרוק את הערך ConfigurationException אם יהיו עוד ארגומנטים שלא עברו עיבוד. |
| החזרות | |
|---|---|
IConfiguration |
IConfiguration שנטען. השדות Option של אובייקט העזר נושבו בערכי args. |
| זריקות | |
|---|---|
ConfigurationException |
אם לא ניתן לטעון את ההגדרה |
createConfigurationFromArgs
public abstract IConfiguration createConfigurationFromArgs (String[] args)
שיטה נוחה שמפעילה את ERROR(/#createConfigurationFromArgs(String[],List)) עם ארגומנט שני null. לכן, היא תשליך את הערך ConfigurationException אם יישארו ארגומנטים שלא נצרכו.
| פרמטרים | |
|---|---|
args |
String |
| החזרות | |
|---|---|
IConfiguration |
|
| זריקות | |
|---|---|
ConfigurationException |
|
createConfigurationFromArgs
public abstract IConfiguration createConfigurationFromArgs (String[] args,unconsumedArgs, IKeyStoreClient keyStoreClient)
יצירת IConfiguration מארגומנטים בשורת הפקודה באמצעות מאגר מפתחות.
הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנית או נתיב לקובץ XML של תצורה.
| פרמטרים | |
|---|---|
args |
String: הארגומנטים בשורת הפקודה |
unconsumedArgs |
: רשימה שתתמלא בארגומנטים שלא נצרכו על ידי האובייקטים שמשויכים לתצורה שצוינה. אם הערך הוא null, ההטמעה תזרוק את הערך ConfigurationException אם יהיו עוד ארגומנטים שלא עברו עיבוד. |
keyStoreClient |
IKeyStoreClient: IKeyStoreClient שמשמש לאחזור מידע אישי רגיש ב-args. |
| החזרות | |
|---|---|
IConfiguration |
IConfiguration שנטען. השדות Option של אובייקט העזר נושבו בערכי args. |
| זריקות | |
|---|---|
ConfigurationException |
אם לא ניתן לטעון את ההגדרה |
createGlobalConfigurationFromArgs
public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args,nonGlobalArgs)
יצירת IGlobalConfiguration מארגומנטים בשורת הפקודה.
הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנית או נתיב לקובץ XML של תצורה.
| פרמטרים | |
|---|---|
args |
String: הארגומנטים בשורת הפקודה |
nonGlobalArgs |
: רשימה שתתמלא בארגומנטים שלא עברו עיבוד כארגומנטים גלובליים |
| החזרות | |
|---|---|
IGlobalConfiguration |
IGlobalConfiguration שנטען. השדות Option של אובייקט העזר הושהו בערכי args. |
| זריקות | |
|---|---|
ConfigurationException |
אם לא ניתן לטעון את ההגדרה |
createPartialConfigurationFromArgs
public abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
יצירת הגדרה אישית שמכילה רק קבוצה של אובייקטים שנבחרו.
| פרמטרים | |
|---|---|
arrayArgs |
String: הארגומנטים בשורת הפקודה |
keyStoreClient |
IKeyStoreClient: IKeyStoreClient שמשמש לאחזור מידע רגיש ב-args. |
allowedObjects |
: קבוצת האובייקטים שמותר ליצור |
delegator |
TradefedDelegator |
| החזרות | |
|---|---|
IConfiguration |
ה-IConfiguration שנטען. |
| זריקות | |
|---|---|
ConfigurationException |
אם לא ניתן לטעון את ההגדרה |
dumpConfig
public abstract void dumpConfig (String configName,
PrintStream out)יצירת גרסת dump של תוכן ההגדרות ב-ERROR(/PrintStream) שצוין
| פרמטרים | |
|---|---|
configName |
String: שם ההגדרות האישיות |
out |
PrintStream: ה-ERROR(/PrintStream) שאליו רוצים להעביר את הפלט |
getConfigList
public abstractgetConfigList ()
הפונקציה מחזירה את רשימת השמות של כל הגדרות ה-config שנמצאות בקובצי ה-JAR ב-classpath. לא מתבצע ניסיון לטעון אף אחד מהקובצי התצורה, כך שיכול להיות שיהיו ברשימה קובצי תצורה שלא פועלים.
| החזרות | |
|---|---|
|
|
getConfigList
public abstractgetConfigList (String subPath, boolean loadFromEnv)
וריאציה של getConfigList() שבה אפשר לציין אם רוצים גם לטעון את התצורה מהסביבה.
| פרמטרים | |
|---|---|
subPath |
String: השם של ספריות המשנה שבהן ייבדקו הגדרות. אם הערך הוא null, ההתנהגות תהיה זהה לזו של getConfigList(). |
loadFromEnv |
boolean: הערך True (נכון) אם צריך לטעון את ההגדרות במשתנה הסביבה. |
| החזרות | |
|---|---|
|
|
printHelp
public abstract void printHelp (PrintStream out)
הדפסות עוזרות להפיק את הפלט של המפעל הזה.
הדפסת מידע כללי לעזרה ורשימת כל ההגדרות הזמינות.
| פרמטרים | |
|---|---|
out |
PrintStream: ה-ERROR(/PrintStream) שאליו רוצים להעביר את הפלט |
printHelpForConfig
public abstract void printHelpForConfig (String[] args,
boolean importantOnly,
PrintStream out)הדפסת פלט עזרה של IConfiguration שצוין בארגומנטים של שורת הפקודה,
אם 'args' מפנה לתצורה ידועה, ייווצר אובייקט IConfiguration מ-XML ותופיע עזרה לגבי IConfiguration הזה. חשוב לזכור שכל שאר הערכים של 'args' יידחו (כלומר, טקסט העזרה יתאר את הערכים הנוכחיים של Options כפי שהם נטענו מ-XML, ולא ישקף את ערכי האפשרויות שהוגדרו על ידי args בשורת הפקודה.
אם 'args' לא מפנה ל-IConfiguration ידוע, תוצג העזרה הכלליות של printHelp(PrintStream).
| פרמטרים | |
|---|---|
args |
String: הארגומנטים בשורת הפקודה |
importantOnly |
boolean: אם הערך הוא true, תודפס עזרה מקוצרת עם הפרטים החשובים בלבד |
out |
PrintStream: ה-ERROR(/PrintStream) שאליו רוצים להעביר את הפלט |