ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

פקטורי ליצירת IConfiguration.

סיכום

כיתות בתצוגת עץ

class ConfigurationFactory.ConfigLoader

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

class ConfigurationFactory.ExceptionLoader

 

יוצרים מוגנים

ConfigurationFactory()

שיטות ציבוריות

void clearMapConfig()

במקרים מסוימים, אנחנו צריכים לנקות את המפה.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

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

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient)

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

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

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

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

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

IConfiguration createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator)

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

void dumpConfig(String configName, PrintStream out)

יצירת גרסת dump של תוכן ההגדרות ב-ERROR(/PrintStream) שצוין

getConfigList(String subPath, boolean loadFromEnv)

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

getConfigList()

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

static IConfigurationFactory getInstance()

אחזור של מופע ה-singleton IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

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

void loadAndPrintAllConfigs()

שיטת שירות שבודקת שאפשר לטעון את כל ההגדרות, לנתח אותן ולהגדיר את כל ערכי האפשרויות.

void printHelp(PrintStream out)

הדפסות עוזרות להפיק את הפלט של המפעל הזה.

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

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

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

שיטות מוגנות

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

החזרת הקידומת של הנתיב של קובצי ה-XML של התצורה ב-classpath

החשיפה מאפשרת לבצע בדיקות מק"ט.

BufferedInputStream getConfigStream(String name)

טעינת InputStream לשם תצורה נתון

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

אחזור של ConfigurationDef לשם הפרטי

getMapConfig()

חשוף לבדיקה.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

ממיינים מחדש את הארגומנטים כך שכל הארגומנטים של template:map יועברו לחלק הקדמי.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

יוצרים מוגנים

ConfigurationFactory

protected ConfigurationFactory ()

שיטות ציבוריות

clearMapConfig

public void clearMapConfig ()

במקרים מסוימים, אנחנו צריכים לנקות את המפה.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

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

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

פרמטרים
arrayArgs String: הארגומנטים בשורת הפקודה
unconsumedArgs : רשימה שתתמלא בארגומנטים שלא נצרכו על ידי האובייקטים שמשויכים לתצורה שצוינה. אם הערך הוא null, ההטמעה תזרוק את הערך ConfigurationException אם יהיו עוד ארגומנטים שלא עברו עיבוד.
החזרות
IConfiguration IConfiguration שנטען. השדות Option של אובייקט העזר נושבו בערכי args.
זריקות
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

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

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

פרמטרים
arrayArgs String: הארגומנטים בשורת הפקודה
unconsumedArgs : רשימה שתתמלא בארגומנטים שלא נצרכו על ידי האובייקטים שמשויכים לתצורה שצוינה. אם הערך הוא null, ההטמעה תזרוק את הערך ConfigurationException אם יהיו עוד ארגומנטים שלא עברו עיבוד.
keyStoreClient IKeyStoreClient: IKeyStoreClient שמשמש לאחזור מידע אישי רגיש ב-args.
החזרות
IConfiguration IConfiguration שנטען. השדות Option של אובייקט העזר נושבו בערכי args.
זריקות
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

פרמטרים
arrayArgs String

החזרות
IConfiguration

זריקות
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

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

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

פרמטרים
arrayArgs String: הארגומנטים בשורת הפקודה
remainingArgs : רשימה שתתמלא בארגומנטים שלא עברו עיבוד כארגומנטים גלובליים
החזרות
IGlobalConfiguration IGlobalConfiguration שנטען. השדות Option של אובייקט העזר הושהו בערכי args.
זריקות
ConfigurationException

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                 allowedObjects, 
                TradefedDelegator delegator)

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

פרמטרים
arrayArgs String: הארגומנטים בשורת הפקודה
keyStoreClient IKeyStoreClient: IKeyStoreClient שמשמש לאחזור מידע רגיש ב-args.
allowedObjects : קבוצת האובייקטים שמותר ליצור
delegator TradefedDelegator

החזרות
IConfiguration ה-IConfiguration שנטען.
זריקות
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

יצירת גרסת dump של תוכן ההגדרות ב-ERROR(/PrintStream) שצוין

פרמטרים
configName String: שם ההגדרות האישיות
out PrintStream: ה-ERROR(/PrintStream) שאליו רוצים להעביר את הפלט

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

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

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

getConfigList

public  getConfigList ()

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

החזרות

getInstance

public static IConfigurationFactory getInstance ()

אחזור של מופע ה-singleton IConfigurationFactory.

החזרות
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

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

פרמטרים
discardExceptions boolean: true אם צריך להתעלם מכל ConfigurationException.
זריקות
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

זריקות
ConfigurationException אם טעינת הגדרה אחת או יותר נכשלה

printHelp

public void printHelp (PrintStream out)

הדפסות עוזרות להפיק את הפלט של המפעל הזה.

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

פרמטרים
out PrintStream: ה-ERROR(/PrintStream) שאליו רוצים להעביר את הפלט

printHelpForConfig

public 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) שאליו רוצים להעביר את הפלט

שיטות מוגנות

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

פרמטרים
name String

החזרות
InputStream

getConfigPrefix

protected String getConfigPrefix ()

החזרת הקידומת של הנתיב של קובצי ה-XML של התצורה ב-classpath

החשיפה מאפשרת לבצע בדיקות מק"ט.

החזרות
String String נתיב עם / בסוף

getConfigStream

protected BufferedInputStream getConfigStream (String name)

טעינת InputStream לשם תצורה נתון

פרמטרים
name String: שם ההגדרות האישיות לטעינה
החזרות
BufferedInputStream ERROR(/BufferedInputStream) לקריאת תוכן התצורה
זריקות
ConfigurationException אם לא ניתן למצוא את הקובץ config

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                 templateMap)

אחזור של ConfigurationDef לשם הפרטי

פרמטרים
name String: השם של תצורה מובנית לטעינה או נתיב לקובץ תצורה לטעינה
isGlobal boolean

templateMap

החזרות
ConfigurationDef ConfigurationDef
זריקות
ConfigurationException אם אירעה שגיאה בטעינת התצורה

getMapConfig

protected  getMapConfig ()

חשוף לבדיקה. להחזיר עותק של המפה.

החזרות

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

פרמטרים
configName String

החזרות
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

ממיינים מחדש את הארגומנטים כך שכל הארגומנטים של template:map יועברו לחלק הקדמי.

פרמטרים
args String

החזרות
String[]

resolveRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

פרמטרים
configURI URI

destDir URI

החזרות
IRemoteFileResolver.ResolvedFile

זריקות
BuildRetrievalError