配置工厂
public class ConfigurationFactory
extends Object
implements IConfigurationFactory
java.lang.Object | |
↳ | com.android.tradefed.config.ConfigurationFactory |
用于创建IConfiguration
工厂。
概括
嵌套类 | |
---|---|
class | ConfigurationFactory.ConfigLoader |
class | ConfigurationFactory.ExceptionLoader
|
受保护的构造函数 | |
---|---|
ConfigurationFactory () |
公共方法 | |
---|---|
void | clearMapConfig () 在某些特定情况下,我们需要清除地图。 |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) 从命令行参数创建 |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) 使用密钥存储从命令行参数创建 |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs) 一种 |
IGlobalConfiguration | createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) 从命令行参数创建 |
IConfiguration | createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) 创建仅包含一组选定对象的配置。 |
void | dumpConfig (String configName, PrintStream out) 将配置内容转储到给定的 |
getConfigList (String subPath, boolean loadFromEnv) | |
getConfigList () 返回在类路径上的 JAR 中找到的所有配置的名称列表。 | |
static IConfigurationFactory | getInstance () 获取单例 |
void | loadAllConfigs (boolean discardExceptions) 加载在类路径和测试用例目录中找到的所有配置。 |
void | loadAndPrintAllConfigs () 检查是否可以加载、解析所有配置以及设置所有选项值的实用方法。 |
void | printHelp (PrintStream out) 打印此工厂的帮助输出。 |
void | printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) 打印命令行参数中指定的 IConfiguration 对象,并输出该IConfiguration 的帮助。 |
受保护的方法 | |
---|---|
InputStream | getBundledConfigStream (String name) |
String | getConfigPrefix () 返回类路径上配置 xml 文件的路径前缀 公开以便单元测试可以模拟。 |
BufferedInputStream | getConfigStream (String name) 为给定的配置名称加载一个 InputStream |
ConfigurationDef | getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap) 检索给定名称的 |
getMapConfig () 暴露测试。 | |
boolean | isDirectConfiguration (String configName) |
String[] | reorderArgs (String[] args) 重新排序 args,以便 template:map args 全部移到前面。 |
IRemoteFileResolver.ResolvedFile | resolveRemoteFile (URI configURI, URI destDir) |
受保护的构造函数
配置工厂
protected ConfigurationFactory ()
公共方法
clearMapConfig
public void clearMapConfig ()
在某些特定情况下,我们需要清除地图。
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
从命令行参数创建IConfiguration
。
参数 | |
---|---|
arrayArgs | String :命令行参数 |
unconsumedArgs | null ,那么如果仍有任何未处理的参数,则实现将抛出ConfigurationException 。 |
退货 | |
---|---|
IConfiguration | 加载的IConfiguration 。委托对象Option 字段已使用 args 中的值填充。 |
投掷 | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
使用密钥存储从命令行参数创建IConfiguration
。
参数 | |
---|---|
arrayArgs | String :命令行参数 |
unconsumedArgs | null ,那么如果仍有任何未处理的参数,则实现将抛出ConfigurationException 。 |
keyStoreClient | IKeyStoreClient :一个IKeyStoreClient ,用于获取 args 中的敏感信息。 |
退货 | |
---|---|
IConfiguration | 加载的IConfiguration 。委托对象Option 字段已使用 args 中的值填充。 |
投掷 | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
一种null
第二个参数调用ERROR(/#createConfigurationFromArgs(String[],List))
便捷方法。因此,如果仍有任何未使用的参数,它将抛出ConfigurationException
。
参数 | |
---|---|
arrayArgs | String |
退货 | |
---|---|
IConfiguration |
投掷 | |
---|---|
ConfigurationException |
createGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
从命令行参数创建IGlobalConfiguration
。
参数 | |
---|---|
arrayArgs | String :命令行参数 |
remainingArgs |
退货 | |
---|---|
IGlobalConfiguration | 加载的IGlobalConfiguration 。委托对象Option 字段已使用 args 中的值填充。 |
投掷 | |
---|---|
ConfigurationException |
createPartialConfigurationFromArgs
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
创建仅包含一组选定对象的配置。
参数 | |
---|---|
arrayArgs | String :命令行参数 |
keyStoreClient | IKeyStoreClient :一个IKeyStoreClient ,用于获取 args 中的敏感信息。 |
allowedObjects | |
delegator | TradefedDelegator |
退货 | |
---|---|
IConfiguration | 加载的IConfiguration 。 |
投掷 | |
---|---|
ConfigurationException |
转储配置
public void dumpConfig (String configName, PrintStream out)
将配置内容转储到给定的ERROR(/PrintStream)
参数 | |
---|---|
configName | String : 配置名称 |
out | PrintStream :将输出转储到的ERROR(/PrintStream) |
获取配置列表
publicgetConfigList (String subPath, boolean loadFromEnv)
getConfigList()
的变体 where 可以指定我们是否还想从环境中加载配置。
参数 | |
---|---|
subPath | String :要查找配置的子目录的名称。如果为 null,将具有与getConfigList() 相同的行为。 |
loadFromEnv | boolean :如果我们应该在环境变量中加载配置,则为真。 |
退货 | |
---|---|
获取配置列表
publicgetConfigList ()
返回在类路径上的 JAR 中找到的所有配置的名称列表。不尝试加载任何配置,因此此列表中可能有无效配置。
退货 | |
---|---|
获取实例
public static IConfigurationFactory getInstance ()
获取单例IConfigurationFactory
实例。
退货 | |
---|---|
IConfigurationFactory |
loadAllConfigs
public void loadAllConfigs (boolean discardExceptions)
加载在类路径和测试用例目录中找到的所有配置。
参数 | |
---|---|
discardExceptions | boolean :如果应忽略任何 ConfigurationException,则为 true。 |
投掷 | |
---|---|
| com.android.tradefed.config.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
的帮助输出,
IConfiguration
对象,并输出该IConfiguration
的帮助。请注意,所有其他“args”值都将被忽略(即帮助文本将描述从 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 |
获取配置前缀
protected String getConfigPrefix ()
返回类路径上配置 xml 文件的路径前缀
公开以便单元测试可以模拟。
退货 | |
---|---|
String | 带有尾随 / ERROR(/String) 路径 |
获取配置流
protected BufferedInputStream getConfigStream (String name)
为给定的配置名称加载一个 InputStream
参数 | |
---|---|
name | String : 要加载的配置名称 |
退货 | |
---|---|
BufferedInputStream | 读取配置内容的ERROR(/BufferedInputStream) |
投掷 | |
---|---|
ConfigurationException | 如果找不到配置 |
获取配置定义
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,templateMap)
检索给定名称的ConfigurationDef
参数 | |
---|---|
name | String : 要加载的内置配置的名称或要加载的配置文件的文件路径 |
isGlobal | boolean |
templateMap |
退货 | |
---|---|
ConfigurationDef | ConfigurationDef |
投掷 | |
---|---|
ConfigurationException | 如果加载配置时发生错误 |
获取地图配置
protectedgetMapConfig ()
暴露测试。返回地图的副本。
退货 | |
---|---|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
参数 | |
---|---|
configName | String |
退货 | |
---|---|
boolean |
重新排序参数
protected String[] reorderArgs (String[] args)
重新排序 args,以便 template:map args 全部移到前面。
参数 | |
---|---|
args | String |
退货 | |
---|---|
String[] |
解析远程文件
protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)
参数 | |
---|---|
configURI | URI |
destDir | URI |
退货 | |
---|---|
IRemoteFileResolver.ResolvedFile |
投掷 | |
---|---|
BuildRetrievalError |
本页面上的内容和代码示例受内容许可部分所述许可的限制。Java 和 OpenJDK 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2023-03-30。