ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

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

סיכום

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

class ConfigurationFactory.ConfigLoader

הטמעת IConfigDefLoader שעוקבת אחרי ההגדרות האישיות הכלולות הגדרה ברמה הבסיסית (root), וגורמת לחריגה מהגדרות מעגליות מסוג 'כולל'. 

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()

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

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

BufferedInputStream getConfigStream(String name)

טוענת זרם קלט עבור שם תצורה נתון

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 ()

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

cleanMapConfig

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 שמשמש לקבלת מידע רגיש ארגומנטים.
allowedObjects : קבוצת האובייקטים המותרים ליצירה
delegator TradefedDelegator

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

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

העתקת התוכן של ההגדרות אל 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 ()

החזרת רשימת השמות של כל ההגדרות שנמצאו ב-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) שאליו רוצים לגרום ליצירת גרסת dump של הפלט

שיטות מוגנות

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

פרמטרים
name String

החזרות
InputStream

getConfigPrefix

protected String getConfigPrefix ()

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

נחשפו כך שבדיקות היחידה יוכלו לדמות.

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

getConfigStream

protected BufferedInputStream getConfigStream (String name)

טוענת זרם קלט עבור שם תצורה נתון

פרמטרים
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