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) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs)

צור את IConfiguration של שורת הפקודה.

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

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

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs)

צור IGlobalConfiguration של שורת הפקודה.

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

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

void dumpConfig (String configName, PrintStream out)

משליך את תוכן התצורה ל- ERROR(/PrintStream) הנתון

getConfigList (String subPath, boolean loadFromEnv)

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

getConfigList ()

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

חשוף כך שבדיקות יחידה יכולות ללעוג.

BufferedInputStream getConfigStream (String name)

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

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

אחזר את ConfigurationDef עבור השם הנתון

getMapConfig ()

נחשף לבדיקה.

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

סדר מחדש את ה-ars כך ש-template:map args יועברו כולם לחזית.

File resolveRemoteFile (URI configURI, URI destDir)

קונסטרוקטורים מוגנים

ConfigurationFactory

protected ConfigurationFactory ()

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

clearMapConfig

public void clearMapConfig ()

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

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

צור את IConfiguration של שורת הפקודה.

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

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

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

החזרות
IConfiguration IConfiguration שנטען. שדות ה-Delegate Object Option אוכלסו בערכים ב-ars.

זורק
ConfigurationException

createConfigurationFromArgs

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

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

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

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

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

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

החזרות
IConfiguration IConfiguration שנטען. שדות ה-Delegate Object Option אוכלסו בערכים ב-ars.

זורק
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 [אפשרויות]", כאשר CONFIG הוא שם התצורה המובנית או נתיב קובץ לקובץ xml תצורה.

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

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

החזרות
IGlobalConfiguration ה- IGlobalConfiguration שנטען. שדות ה-Delegate Object Option אוכלסו בערכים ב-ars.

זורק
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)

משליך את תוכן התצורה ל- ERROR(/PrintStream) הנתון

פרמטרים
configName String : שם התצורה

out PrintStream : ה- ERROR(/PrintStream) יש לשפוך פלט

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

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

פרמטרים
subPath String : שם ספריות המשנה שיש לחפש בהן לתצורה. אם null, תהיה אותה התנהגות כמו getConfigList() .

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

החזרות

getConfigList

public  getConfigList ()

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

החזרות

getInstance

public static IConfigurationFactory getInstance ()

קבל את המופע singleton IConfigurationFactory .

החזרות
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

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

פרמטרים
discardExceptions boolean : true אם יש להתעלם מכל ConfigurationException.

זורק
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

זורק
ConfigurationException אם תצורה אחת או יותר לא הצליחה להיטען

הדפס עזרה

public void printHelp (PrintStream out)

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

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

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

הדפס עזרה להגדרות

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

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

אם 'args' מתייחס לתצורה ידועה, אובייקט IConfiguration ייווצר מ-XML, ועזרה עבור IConfiguration זו תופק. שימו לב שכל שאר ערכי ה-'args' יתעלמו (כלומר, טקסט העזרה יתאר את הערכים הנוכחיים של Options כפי שנטענו מ-XML, ולא ישקף את ערכי Option שנקבעו על-ידי 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 config ב-classpath

חשוף כך שבדיקות יחידה יכולות ללעוג.

החזרות
String שביל String עם נגרר /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

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

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

סדר מחדש את Args

protected String[] reorderArgs (String[] args)

סדר מחדש את ה-ars כך ש-template:map args יועברו כולם לחזית.

פרמטרים
args String

החזרות
String[]

resolveRemoteFile

protected File resolveRemoteFile (URI configURI, 
                URI destDir)

פרמטרים
configURI URI

destDir URI

החזרות
File

זורק
BuildRetrievalError