IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


מפעל ליצירת IConfiguration

סיכום

‫methods ציבוריים

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient)

יצירת IConfiguration מארגומנטים של שורת פקודה באמצעות מאגר מפתחות.

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs)

יוצרים את IConfiguration מארגומנטים בשורת הפקודה.

abstract IConfiguration createConfigurationFromArgs(String[] args)

שיטה נוחה שמפעילה את createConfigurationFromArgs(String[],List) עם ארגומנט של null שניות.

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, List<String> nonGlobalArgs)

ליצור IGlobalConfiguration מארגומנטים בשורת הפקודה.

abstract IConfiguration createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator)

יוצרים הגדרה שמכילה רק קבוצה של אובייקטים נבחרים.

abstract void dumpConfig(String configName, PrintStream out)

התוכן של ההגדרה נשמר ב-PrintStream שצוין

abstract List<String> getConfigList()

הפונקציה מחזירה את רשימת השמות של כל ההגדרות שנמצאו בקובצי ה-JAR בנתיב המחלקה.

abstract List<String> getConfigList(String subPath, boolean loadFromEnv)

גרסה של getConfigList() שבה אפשר לציין אם רוצים לטעון את ההגדרה גם מהסביבה.

abstract void printHelp(PrintStream out)

הפונקציה prints עוזרת להפיק פלט עבור המפעל הזה.

abstract void printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)

הדפסת פלט העזרה עבור IConfiguration שצוין בארגומנטים של שורת הפקודה,

אם 'args' מתייחס להגדרה מוכרת, ייצור אובייקט IConfiguration מ-XML, ויוצג פלט של עזרה לגבי IConfiguration.

‫methods ציבוריים

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

יצירת IConfiguration מארגומנטים של שורת פקודה באמצעות מאגר מפתחות.

הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנה או נתיב קובץ לתצורת XML.

פרמטרים
args String: הארגומנטים בשורת הפקודה

unconsumedArgs List: רשימה שתאוכלס בארגומנטים שלא נעשה בהם שימוש על ידי האובייקטים שמשויכים להגדרה שצוינה. אם הערך הוא null, ההטמעה תזרוק ConfigurationException אם יישארו ארגומנטים שלא עברו עיבוד.

keyStoreClient IKeyStoreClient: IKeyStoreClient שמשמש להשגת מידע רגיש ב-args.

החזרות
IConfiguration הקובץ IConfiguration שנטען. השדות של אובייקט ההרשאה Option אוכלסו בערכים ב-args.

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן לטעון את ההגדרה

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                List<String> unconsumedArgs)

יוצרים את IConfiguration מארגומנטים בשורת הפקודה.

הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנה או נתיב קובץ לתצורת XML.

פרמטרים
args String: הארגומנטים בשורת הפקודה

unconsumedArgs List: רשימה שתאוכלס בארגומנטים שלא נעשה בהם שימוש על ידי האובייקטים שמשויכים להגדרה שצוינה. אם הערך הוא null, ההטמעה תזרוק ConfigurationException אם יישארו ארגומנטים שלא עברו עיבוד.

החזרות
IConfiguration הקובץ IConfiguration שנטען. השדות של אובייקט ההרשאה Option אוכלסו בערכים ב-args.

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן לטעון את ההגדרה

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

שיטה נוחה שמפעילה את createConfigurationFromArgs(String[],List) עם ארגומנט של null שניות. לכן, הפונקציה תחזיר ConfigurationException אם יישארו ארגומנטים שלא נעשה בהם שימוש.

פרמטרים
args String

החזרות
IConfiguration

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

createGlobalConfigurationFromArgs

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                List<String> nonGlobalArgs)

ליצור IGlobalConfiguration מארגומנטים בשורת הפקודה.

הפורמט הצפוי הוא 'CONFIG [options]', כאשר CONFIG הוא שם התצורה המובנה או נתיב קובץ לתצורת XML.

פרמטרים
args String: הארגומנטים בשורת הפקודה

nonGlobalArgs List: רשימה שתאוכלס בארגומנטים שלא עברו עיבוד כארגומנטים גלובליים

החזרות
IGlobalConfiguration הקובץ IGlobalConfiguration שנטען. השדות של אובייקט הנציג Option אוכלסו בערכים ב-args.

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן לטעון את ההגדרה

createPartialConfigurationFromArgs

public abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                Set<String> allowedObjects, 
                TradefedDelegator delegator)

יוצרים הגדרה שמכילה רק קבוצה של אובייקטים נבחרים.

פרמטרים
arrayArgs String: הארגומנטים בשורת הפקודה

keyStoreClient IKeyStoreClient: IKeyStoreClient שמשמש להשגת מידע רגיש בארגומנטים.

allowedObjects Set: קבוצת האובייקטים שמותר ליצור

delegator TradefedDelegator

החזרות
IConfiguration הטעינה של IConfiguration.

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא ניתן לטעון את ההגדרה

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

התוכן של ההגדרה נשמר ב-PrintStream שצוין

פרמטרים
configName String: שם ההגדרה

out PrintStream: PrintStream שאליו יישלח הפלט

getConfigList

public abstract List<String> getConfigList ()

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

החזרות
List<String>

getConfigList

public abstract List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

גרסה של getConfigList() שבה אפשר לציין אם רוצים לטעון את ההגדרה גם מהסביבה.

פרמטרים
subPath String: השם של תיקיות המשנה שבהן צריך לחפש את ההגדרות. אם הערך הוא null, ההתנהגות תהיה זהה לזו של getConfigList().

loadFromEnv boolean: הערך True אם צריך לטעון את ההגדרה במשתנה הסביבה.

החזרות
List<String>

printHelp

public abstract void printHelp (PrintStream out)

הפונקציה prints עוזרת להפיק פלט עבור המפעל הזה.

מדפיסה מידע כללי על עזרה ומפרטת את כל ההגדרות הזמינות.

פרמטרים
out PrintStream: PrintStream שאליו יישלח הפלט

printHelpForConfig

public abstract void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

הדפסת פלט העזרה עבור IConfiguration שצוין בארגומנטים של שורת הפקודה,

אם 'args' מתייחס להגדרה מוכרת, ייצור אובייקט IConfiguration מ-XML, ויוצג פלט של עזרה לגבי IConfiguration. שימו לב: המערכת תתעלם מכל שאר הערכים של 'args' (כלומר, טקסט העזרה יתאר את הערכים הנוכחיים של Options כפי שהם נטענו מ-XML, ולא ישקף את הערכים של האפשרות שמוגדרים על ידי ארגומנטים של שורת הפקודה).

אם 'args' לא מפנה אל IConfiguration ידוע, תוצג עזרה כללית של printHelp(PrintStream).

פרמטרים
args String: הארגומנטים בשורת הפקודה

importantOnly boolean: אם true, מדפיסים רשימת עזרה מקוצרת עם הפרטים החשובים בלבד

out PrintStream: PrintStream שאליו יישלח הפלט