為配合主幹穩定開發模型，並確保生態系統的平台穩定性，我們將自 2026 年起，在第 2 季和第 4 季將原始碼發布至 AOSP。如要建構及貢獻 AOSP，請使用 android-latest-release。android-latest-release 資訊清單分支版本一律會參照推送至 Android 開放原始碼計畫的最新版本。詳情請參閱「Android 開放原始碼計畫變更」。

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory

已知間接子類別

ConfigurationFactory、GCSConfigurationFactory、RetryConfigurationFactory、SandboxConfigurationFactory

ConfigurationFactory	用於建立 `IConfiguration` 的處理站。
GCSConfigurationFactory	`ConfigurationFactory` 會從 Google Cloud Storage 載入設定。
RetryConfigurationFactory	這個工廠會處理指令重試作業。
SandboxConfigurationFactory	特殊設定工廠，用於處理沙箱設定的建立作業。

用於建立 IConfiguration 的工廠

摘要

公用方法
`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)` 便利方法，會使用 `null` 第二個引數呼叫 `createConfigurationFromArgs(String[],List)`。
`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)` 列印這個工廠的說明輸出內容。
`abstract void`	`printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)` 輸出指令列引數中指定的 `IConfiguration` 說明，如果「args」是指已知設定，系統會從 XML 建立 `IConfiguration` 物件，並輸出該 `IConfiguration` 的說明。

公用方法

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`：用於在 args 中取得私密資訊的 `IKeyStoreClient`。

傳回
`IConfiguration`	已載入的 `IConfiguration`。委派物件 `Option` 欄位已填入 args 中的值。

擲回
`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 中的值。

擲回
`ConfigurationException`	如果無法載入設定

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

便利方法，會使用 null 第二個引數呼叫 createConfigurationFromArgs(String[],List)。因此，如果還有未使用的引數，就會擲回 ConfigurationException。

參數
`args`	`String`

傳回
`IConfiguration`

擲回
`ConfigurationException`

另請參閱：

createConfigurationFromArgs(String[],List)

createGlobalConfigurationFromArgs

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

從指令列引數建立 IGlobalConfiguration。

預期格式為「CONFIG [options]」，其中 CONFIG 是內建設定名稱，或是設定 XML 檔案的路徑。

參數
`args`	`String`：指令列引數
`nonGlobalArgs`	`List`：這個清單會填入未處理為全域引數的引數

傳回
`IGlobalConfiguration`	已載入的 `IGlobalConfiguration`。委派物件 `Option` 欄位已填入 args 中的值。

擲回
`ConfigurationException`	如果無法載入設定

createPartialConfigurationFromArgs

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

建立只包含一組所選物件的設定。

參數
`arrayArgs`	`String`：指令列引數
`keyStoreClient`	`IKeyStoreClient`：用於在 args 中取得機密資訊的 `IKeyStoreClient`。
`allowedObjects`	`Set`：允許建立的物件集
`delegator`	`TradefedDelegator`

傳回
`IConfiguration`	載入的 `IConfiguration`。

擲回
`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`：要搜尋設定的子目錄名稱。如果為空值，則行為與 `getConfigList()` 相同。
`loadFromEnv`	`boolean`：如果應載入環境變數中的設定，則為 True。

傳回
`List<String>`

printHelp

public abstract void printHelp (PrintStream out)

列印這個工廠的說明輸出內容。

列印一般說明資訊，並列出所有可用設定。

參數
`out`	`PrintStream`：要將輸出內容傾印至的 `PrintStream`

printHelpForConfig

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

輸出指令列引數中指定的 IConfiguration 說明，

如果「args」是指已知設定，系統會從 XML 建立 IConfiguration 物件，並輸出該 IConfiguration 的說明。請注意，系統會忽略所有其他「args」值 (也就是說，說明文字會說明從 XML 載入的 Option 目前值，不會反映指令列引數設定的選項值)。

如果「args」未參照已知 IConfiguration，系統會顯示一般 printHelp(PrintStream) 說明。

參數
`args`	`String`：指令列引數
`importantOnly`	`boolean`：如果為 `true`，請列印簡短的說明清單，只列出重要詳細資料
`out`	`PrintStream`：要將輸出內容傾印至的 `PrintStream`