to top
public interface

IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory
Known Indirect Subclasses

Class Overview

Factory for creating IConfigurations

Summary

Public Methods
abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs)
Create the IConfiguration from command line arguments.
abstract IConfiguration createConfigurationFromArgs(String[] args)
A convenience method which calls ERROR(/createConfigurationFromArgs(String[], List)) with a null second argument.
abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, List<String> nonGlobalArgs)
Create a IGlobalConfiguration from command line arguments.
abstract void dumpConfig(String configName, PrintStream out)
Dumps the contents of the configuration to the given PrintStream
abstract void printHelp(PrintStream out)
Prints help output for this factory.
abstract void printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)
Prints help output for the IConfiguration specified in command line arguments,

If 'args' refers to a known configuration, a IConfiguration object will be created from XML, and help for that IConfiguration will be outputted.

Public Methods

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

Create the IConfiguration from command line arguments.

Expected format is "CONFIG [options]", where CONFIG is the built-in configuration name or a file path to a configuration xml file.

Parameters
args String: the command line arguments
unconsumedArgs List: a List which will be populated with the arguments that were not consumed by the Objects associated with the specified config. If this is null, then the implementation will throw ConfigurationException if any unprocessed args remain.
Returns
IConfiguration the loaded IConfiguration. The delegate object Option fields have been populated with values in args.
Throws
ConfigurationException} if configuration could not be loaded
ConfigurationException

public abstract IConfiguration createConfigurationFromArgs (String[] args)

A convenience method which calls ERROR(/createConfigurationFromArgs(String[], List)) with a null second argument. Thus, it will throw ConfigurationException if any unconsumed arguments remain.

Parameters
args String
Returns
IConfiguration
Throws
ConfigurationException

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

Create a IGlobalConfiguration from command line arguments.

Expected format is "CONFIG [options]", where CONFIG is the built-in configuration name or a file path to a configuration xml file.

Parameters
args String: the command line arguments
nonGlobalArgs List: a list which will be populated with the arguments that weren't processed as global arguments
Returns
IGlobalConfiguration the loaded IGlobalConfiguration. The delegate object Option fields have been populated with values in args.
Throws
ConfigurationException} if configuration could not be loaded
ConfigurationException

public abstract void dumpConfig (String configName, PrintStream out)

Dumps the contents of the configuration to the given PrintStream

Parameters
configName String: the configuration name
out PrintStream: the PrintStream to dump output to

public abstract void printHelp (PrintStream out)

Prints help output for this factory.

Prints a generic help info, and lists all available configurations.

Parameters
out PrintStream: the PrintStream to dump output to

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

Prints help output for the IConfiguration specified in command line arguments,

If 'args' refers to a known configuration, a IConfiguration object will be created from XML, and help for that IConfiguration will be outputted. Note all other 'args' values will be ignored (ie the help text will describe the current values of Options as loaded from XML, and will not reflect option's values set by the command line args.

If 'args' does not reference a known IConfiguration, the generic printHelp(PrintStream) help will be displayed.

Parameters
args String: the command line arguments
importantOnly boolean: if true, print an abbreviated help listing only the important details
out PrintStream: the PrintStream to dump output to