自 2026 年起，为了与我们的主干稳定开发模型保持一致，并确保生态系统的平台稳定性，我们将在第 2 季度和第 4 季度向 AOSP 发布源代码。如需构建 AOSP 并为其贡献代码，请使用 android-latest-release。android-latest-release 清单分支将始终引用推送到 AOSP 的最新版本。如需了解详情，请参阅 AOSP 变更。

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`：一个 `IKeyStoreClient`，用于获取实参中的敏感信息。

返回
`IConfiguration`	加载的 `IConfiguration`。委托对象 `Option` 字段已填充实参中的值。

抛出
`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` 字段已填充实参中的值。

抛出
`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` 字段已填充实参中的值。

抛出
`ConfigurationException`	如果无法加载配置

createPartialConfigurationFromArgs

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

创建仅包含一组所选对象的配置。

参数
`arrayArgs`	`String`：命令行实参
`keyStoreClient`	`IKeyStoreClient`：一个 `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`：要查找配置的子目录的名称。如果为 null，则行为与 `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`