配置工厂

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


用于创建IConfiguration工厂

概括

公共方法

abstract IConfiguration createConfigurationFromArgs (String[] args, unconsumedArgs) createConfigurationFromArgs (String[] args, unconsumedArgs)

从命令行参数创建IConfiguration

abstract IConfiguration createConfigurationFromArgs (String[] args)

一种使用第二个参数为null来调用ERROR(/#createConfigurationFromArgs(String[],List))便捷方法。

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

使用密钥存储从命令行参数创建IConfiguration

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

从命令行参数创建IGlobalConfiguration

abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) 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的帮助。

公共方法

从参数创建配置

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

从命令行参数创建IConfiguration

预期格式为“CONFIG [选项]”,其中 CONFIG 是内置配置名称或配置 xml 文件的文件路径。

参数
args String : 命令行参数

unconsumedArgs :一个列表,将填充与指定配置关联的对象未使用的参数。如果这是null ,那么如果仍有任何未处理的参数,实现将抛出ConfigurationException

退货
IConfiguration加载的IConfiguration 。委托对象Option字段已填充有 args 中的值。

投掷
ConfigurationException如果无法加载配置

从参数创建配置

public abstract IConfiguration createConfigurationFromArgs (String[] args)

一种使用第二个参数为null来调用ERROR(/#createConfigurationFromArgs(String[],List))便捷方法。因此,如果还有任何未使用的参数,它将抛出ConfigurationException

参数
args String

退货
IConfiguration

投掷
ConfigurationException

从参数创建配置

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

使用密钥存储从命令行参数创建IConfiguration

预期格式为“CONFIG [选项]”,其中 CONFIG 是内置配置名称或配置 xml 文件的文件路径。

参数
args String : 命令行参数

unconsumedArgs :一个列表,将填充与指定配置关联的对象未使用的参数。如果这是null ,那么如果仍有任何未处理的参数,实现将抛出ConfigurationException

keyStoreClient IKeyStoreClient :一个IKeyStoreClient ,用于获取参数中的敏感信息。

退货
IConfiguration加载的IConfiguration 。委托对象Option字段已填充有 args 中的值。

投掷
ConfigurationException如果无法加载配置

从参数创建全局配置

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

从命令行参数创建IGlobalConfiguration

预期格式为“CONFIG [选项]”,其中 CONFIG 是内置配置名称或配置 xml 文件的文件路径。

参数
args String : 命令行参数

nonGlobalArgs :一个列表,其中将填充未作为全局参数处理的参数

退货
IGlobalConfiguration加载的IGlobalConfiguration 。委托对象Option字段已填充有 args 中的值。

投掷
ConfigurationException如果无法加载配置

从参数创建部分配置

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

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

参数
arrayArgs String : 命令行参数

keyStoreClient IKeyStoreClient :一个IKeyStoreClient ,用于获取参数中的敏感信息。

allowedObjects :允许创建的对象集

delegator TradefedDelegator

退货
IConfiguration加载的IConfiguration

投掷
ConfigurationException如果无法加载配置

转储配置

public abstract void dumpConfig (String configName, 
                PrintStream out)

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

参数
configName String : 配置名称

out PrintStream :将输出转储到的ERROR(/PrintStream)

获取配置列表

public abstract  getConfigList ()

返回在类路径上的 JAR 中找到的所有配置的名称列表。不尝试加载任何配置,因此此列表中可能有非工作配置。

退货

获取配置列表

public abstract  getConfigList (String subPath, 
                boolean loadFromEnv)

getConfigList()的变体可以指定我们是否也想从环境中加载配置。

参数
subPath String :要查找配置的子目录的名称。如果为 null,将具有与getConfigList()相同的行为。

loadFromEnv boolean :如果我们应该在环境变量中加载配置,则为 True。

退货

打印帮助

public abstract void printHelp (PrintStream out)

打印该工厂的帮助输出。

打印通用帮助信息,并列出所有可用的配置。

参数
out PrintStream :将输出转储到的ERROR(/PrintStream)

打印帮助配置

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)