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, unconsumedArgs) 通过命令行参数创建 IConfiguration。
abstract IConfiguration	createConfigurationFromArgs(String[] args) 一种便捷方法，用于使用 null 作为第二个参数调用 ERROR(/#createConfigurationFromArgs(String[],List))。
abstract IConfiguration	createConfigurationFromArgs(String[] args, unconsumedArgs, IKeyStoreClient keyStoreClient) 使用密钥库从命令行参数创建 IConfiguration。
abstract IGlobalConfiguration	createGlobalConfigurationFromArgs(String[] args, nonGlobalArgs) 使用命令行参数创建 IGlobalConfiguration。
abstract IConfiguration	createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) 创建仅包含一组所选对象的配置。
abstract void	dumpConfig(String configName, PrintStream out) 将配置内容转储到给定的 ERROR(/PrintStream)
abstract	getConfigList() 返回在类路径的 JAR 中找到的所有配置的名称列表。
abstract	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, 
                 unconsumedArgs)

通过命令行参数创建 IConfiguration。

预期格式为“CONFIG [options]”，其中 CONFIG 是内置配置名称或配置 XML 文件的文件路径。

参数
args	String：命令行参数
unconsumedArgs	：一个列表，其中包含与指定配置关联的对象未使用的参数。如果此值为 null，则如果仍有未处理的参数，实现将抛出 ConfigurationException。

返回
IConfiguration	加载的 IConfiguration。代理对象 Option 字段已填充 args 中的值。

抛出
ConfigurationException	if configuration could not be loaded

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

一种便捷方法，用于使用 null 作为第二个参数调用 ERROR(/#createConfigurationFromArgs(String[],List))。因此，如果仍有未使用的参数，它会抛出 ConfigurationException。

参数
args	String

返回
IConfiguration

抛出
ConfigurationException

另见：

• ERROR(/#createConfigurationFromArgs(String[], List))

createConfigurationFromArgs

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

使用密钥库从命令行参数创建 IConfiguration。

预期格式为“CONFIG [options]”，其中 CONFIG 是内置配置名称或配置 XML 文件的文件路径。

参数
args	String：命令行参数
unconsumedArgs	：一个列表，其中包含与指定配置关联的对象未使用的参数。如果此值为 null，则如果仍有未处理的参数，实现将抛出 ConfigurationException。
keyStoreClient	IKeyStoreClient：一个 IKeyStoreClient，用于获取参数中的敏感信息。

返回
IConfiguration	加载的 IConfiguration。代理对象 Option 字段已填充 args 中的值。

抛出
ConfigurationException	if configuration could not be loaded

createGlobalConfigurationFromArgs

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

使用命令行参数创建 IGlobalConfiguration。

预期格式为“CONFIG [options]”，其中 CONFIG 是内置配置名称或配置 XML 文件的文件路径。

参数
args	String：命令行参数
nonGlobalArgs	：一个列表，其中会填充未作为全局参数处理的参数

返回
IGlobalConfiguration	加载的 IGlobalConfiguration。代理对象 Option 字段已使用 args 中的值进行填充。

抛出
ConfigurationException	if configuration could not be loaded

createPartialConfigurationFromArgs

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

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

参数
arrayArgs	String：命令行参数
keyStoreClient	IKeyStoreClient：用于获取参数中敏感信息的 IKeyStoreClient。
allowedObjects	：允许创建的一组对象
delegator	TradefedDelegator

返回
IConfiguration	加载的 IConfiguration。

抛出
ConfigurationException	if configuration could not be loaded

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

将配置内容转储到给定的 ERROR(/PrintStream)

参数
configName	String：配置名称
out	PrintStream：要将输出转储到的 ERROR(/PrintStream)

getConfigList

public abstract  getConfigList ()

返回在类路径的 JAR 中找到的所有配置的名称列表。 不会尝试加载任何配置，因此此列表中可能会包含无效的配置。

返回

getConfigList

public abstract  getConfigList (String subPath, 
                boolean loadFromEnv)

getConfigList() 的变体，用于指定我们是否还想从环境中加载配置。

参数
subPath	String：要查找配置的子目录的名称。如果为 null，则与 getConfigList() 的行为相同。
loadFromEnv	boolean：如果应在环境变量中加载配置，则为 true。

返回

printHelp

public abstract void printHelp (PrintStream out)

输出此工厂的帮助输出。

输出通用帮助信息，并列出所有可用配置。

参数
out	PrintStream：要将输出转储到的 ERROR(/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：要将输出转储到的 ERROR(/PrintStream)