הגדרת היצרן

public class ConfigurationFactory
extends Object implements IConfigurationFactory

JavaScript.lang.Object
↳ com.android.tradefed.config.ConfigurationConfiguration

מפעל ליצירת 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)

העתקת התוכן של ההגדרות אל ERROR(/PrintStream) הנתון

getConfigList(String subPath, boolean loadFromEnv)

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

getConfigList()

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

בנאים מוגנים

הגדרת היצרן

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 שמשמש לקבלת מידע רגיש את הארגומנטים.
החזרות
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

createPARTConfigurationFromArgs (יצירה)

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

loadAllConfig

public void loadAllConfigs (boolean discardExceptions)

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

פרמטרים
discardExceptions boolean: true אם יש להתעלם מחריגה מהגדרות אישיות.
קליעות
com.android.tradefed.config.Configuration וכל החריגות
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

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

עזרה בנושא הדפסה

public void printHelp (PrintStream out)

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

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

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

printHelpForConfig

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

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

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

אם '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 ()

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

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

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

getConfigStream

protected BufferedInputStream getConfigStream (String name)

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

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

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