Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

IConfiguration

public interface IConfiguration

com.android.tradefed.config.IConfiguration

Known indirect subclasses

Configuration

Configuration A concrete IConfiguration implementation that stores the loaded config objects in a map.

Configuration information for a TradeFederation invocation. Each TradeFederation invocation has a single IConfiguration. An IConfiguration stores all the delegate objects that should be used during the invocation, and their associated Option's

Summary

Public methods
`abstract void`	`addFilesToClean( toBeCleaned)` Add files that must be cleaned during `cleanConfigurationData()`
`abstract void`	`cleanConfigurationData()` Delete any files that was downloaded to resolved Option fields of remote files.
`abstract IConfiguration`	`clone()` Create a shallow copy of this object.
`abstract void`	`dumpXml(PrintWriter output)` Gets the expanded XML file for the config with all options shown for this `IConfiguration` as a `String`.
`abstract void`	`dumpXml(PrintWriter output, excludeFilters)` Gets the expanded XML file for the config with all options shown for this `IConfiguration` minus the objects filters by their key name.
`abstract void`	`dumpXml(PrintWriter output, excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions)` Gets the expanded XML file for the config with all options shown for this `IConfiguration` minus the objects filters by their key name.
`abstract`	`getAllConfigurationObjectsOfType(String typeName)` Generic interface to get all the object of one given type name across devices.
`abstract IBuildProvider`	`getBuildProvider()` Gets the `IBuildProvider` from the configuration.
`abstract String`	`getCommandLine()` Gets the command line used to create this `IConfiguration`.
`abstract ICommandOptions`	`getCommandOptions()` Gets the `ICommandOptions` to use from the configuration.
`abstract ConfigurationDescriptor`	`getConfigurationDescription()` Returns the `ConfigurationDescriptor` provided in the configuration.
`abstract Object`	`getConfigurationObject(String typeName)` Generic interface to get the configuration object with the given type name.
`abstract`	`getConfigurationObjectList(String typeName)` Similar to `getConfigurationObject(String)`, but for configuration object types that support multiple objects.
`abstract CoverageOptions`	`getCoverageOptions()` Gets the `CoverageOptions` to use from the configuration.
`abstract`	`getDeviceConfig()` Gets the `IDeviceConfiguration`s from the configuration.
`abstract IDeviceConfiguration`	`getDeviceConfigByName(String nameDevice)` Return the `IDeviceConfiguration` associated to the name provided, null if not found.
`abstract TestDeviceOptions`	`getDeviceOptions()` Gets the `TestDeviceOptions` to use from the configuration.
`abstract IDeviceRecovery`	`getDeviceRecovery()` Gets the `IDeviceRecovery` to use from the configuration.
`abstract IDeviceSelection`	`getDeviceRequirements()` Gets the `IDeviceSelection` to use from the configuration.
`abstract`	`getFilesToClean()` Get the list of files that will be cleaned during `cleanConfigurationData()`
`abstract GlobalTestFilter`	`getGlobalFilters()` Gets the `GlobalTestFilter` for the invocation.
`abstract`	`getInopOptions()` Get the option names that did not change any values
`abstract`	`getLabPreparers()` Gets the `ITargetPreparer`s from the configuration.
`abstract ILeveledLogOutput`	`getLogOutput()` Gets the `ILeveledLogOutput` to use from the configuration.
`abstract ILogSaver`	`getLogSaver()` Gets the `ILogSaver` to use from the configuration.
`abstract`	`getMetricCollectors()` Gets the `IMetricCollector`s from the configuration.
`abstract`	`getMultiPreTargetPreparers()` Gets the `IMultiTargetPreparer`s from the configuration that should be executed before any of the devices target_preparers.
`abstract`	`getMultiTargetPreparers()` Gets the `IMultiTargetPreparer`s from the configuration.
`abstract String`	`getName()` Returns the name of the configuration.
`abstract`	`getPostProcessors()` Gets the `IPostProcessor`s from the configuration.
`abstract IRetryDecision`	`getRetryDecision()` Returns the `IRetryDecision` used for the invocation.
`abstract SkipManager`	`getSkipManager()` Gets the `SkipManager` for the invocation.
`abstract`	`getSystemStatusCheckers()` Gets the `ISystemStatusChecker`s from the configuration.
`abstract`	`getTargetPreparers()` Gets the `ITargetPreparer`s from the configuration.
`abstract`	`getTestInvocationListeners()` Gets the `ITestInvocationListener`s to use from the configuration.
`abstract`	`getTests()` Gets the `IRemoteTest`s to run from the configuration.
`abstract void`	`injectOptionValue(String optionName, String optionValue)` Inject a option value into the set of configuration objects.
`abstract void`	`injectOptionValue(String optionName, String optionKey, String optionValue)` Inject a option value into the set of configuration objects.
`abstract void`	`injectOptionValueWithSource(String optionName, String optionKey, String optionValue, String optionSource)` Inject a option value into the set of configuration objects.
`abstract void`	`injectOptionValues( optionDefs)` Inject multiple option values into the set of configuration objects.
`abstract boolean`	`isDeviceConfiguredFake(String deviceName)` Returns whether or not a configured device is tagged isFake=true or not.
`abstract IConfiguration`	`partialDeepClone( objectToDeepClone, IKeyStoreClient client)` Create a base clone from `clone()` then deep clone the list of given config object.
`abstract void`	`printCommandUsage(boolean importantOnly, PrintStream out)` Outputs a command line usage help text for this configuration to given printStream.
`abstract void`	`resolveDynamicOptions(DynamicRemoteFileResolver resolver)` Resolve options of `ERROR(/File)` pointing to a remote location.
`abstract void`	`safeInjectOptionValues( optionDefs)` Inject multiple option values into the set of configuration objects without throwing if one of the option cannot be applied.
`abstract`	`setBestEffortOptionsFromCommandLineArgs( listArgs, IKeyStoreClient keyStoreClient)` Set the config `Option` fields with given set of command line arguments using a best effort approach.
`abstract void`	`setBuildProvider(IBuildProvider provider)` Replace the current `IBuildProvider` in the configuration.
`abstract void`	`setCommandLine(String[] arrayArgs)` Sets the command line used to create this `IConfiguration`.
`abstract void`	`setCommandOptions(ICommandOptions cmdOptions)` Set the `ICommandOptions`, replacing any existing values
`abstract void`	`setConfigurationObject(String name, Object configObject)` Generic method to set the config object with the given name, replacing any existing value.
`abstract void`	`setConfigurationObjectList(String name, configList)` Generic method to set the config object list for the given name, replacing any existing value.
`abstract void`	`setCoverageOptions(CoverageOptions coverageOptions)` Set the `CoverageOptions`, replacing any existing values.
`abstract void`	`setDeviceConfig(IDeviceConfiguration deviceConfig)` Set a `IDeviceConfiguration`, replacing any existing value.
`abstract void`	`setDeviceConfigList( deviceConfigs)` Set the `IDeviceConfiguration`s, replacing any existing value.
`abstract void`	`setDeviceMetricCollectors( collectors)` Set the list of `IMetricCollector`s, replacing any existing values.
`abstract void`	`setDeviceOptions(TestDeviceOptions deviceOptions)` Set the `TestDeviceOptions`, replacing any existing values
`abstract void`	`setDeviceRecovery(IDeviceRecovery recovery)` Set the `IDeviceRecovery`, replacing any existing value.
`abstract void`	`setDeviceRequirements(IDeviceSelection deviceSelection)` Set the `IDeviceSelection`, replacing any existing values
`abstract void`	`setLabPreparer(ITargetPreparer preparer)` Set the `ITargetPreparer`, replacing any existing value.
`abstract void`	`setLabPreparers( preparers)` Set the list of `ITargetPreparer`s, replacing any existing value.
`abstract void`	`setLogOutput(ILeveledLogOutput logger)` Set the `ILeveledLogOutput`, replacing any existing value.
`abstract void`	`setLogSaver(ILogSaver logSaver)` Set the `ILogSaver`, replacing any existing value.
`abstract void`	`setMultiPreTargetPreparer(IMultiTargetPreparer multiPreTargPreps)` Convenience method to set a single `IMultiTargetPreparer` in this configuration that should be executed before any of the devices target_preparers, replacing any existing values
`abstract void`	`setMultiPreTargetPreparers( multiPreTargPreps)` Set the list of `IMultiTargetPreparer`s in this configuration that should be executed before any of the devices target_preparers, replacing any existing values
`abstract void`	`setMultiTargetPreparer(IMultiTargetPreparer multiTargPrep)` Convenience method to set a single `IMultiTargetPreparer` in this configuration, replacing any existing values
`abstract void`	`setMultiTargetPreparers( multiTargPreps)` Set the list of `IMultiTargetPreparer`s in this configuration, replacing any existing values
`abstract`	`setOptionsFromCommandLineArgs( listArgs)` Set the config `Option` fields with given set of command line arguments `ArgsOptionParser` for expected format
`abstract`	`setOptionsFromCommandLineArgs( listArgs, IKeyStoreClient keyStoreClient)` Set the config `Option` fields with given set of command line arguments See `ArgsOptionParser` for expected format
`abstract void`	`setPostProcessors( processors)` Set the list of `IPostProcessor`s, replacing any existing values.
`abstract void`	`setRetryDecision(IRetryDecision decisionRetry)` Set the `IRetryDecision`, replacing any existing value.
`abstract void`	`setSystemStatusChecker(ISystemStatusChecker systemChecker)` Convenience method to set a single `ISystemStatusChecker` in this configuration, replacing any existing values
`abstract void`	`setSystemStatusCheckers( systemCheckers)` Set the list of `ISystemStatusChecker`s in this configuration, replacing any existing values
`abstract void`	`setTargetPreparer(ITargetPreparer preparer)` Set the `ITargetPreparer`, replacing any existing value.
`abstract void`	`setTargetPreparers( preparers)` Set the list of `ITargetPreparer`s, replacing any existing value.
`abstract void`	`setTest(IRemoteTest test)` Convenience method to set a single `IRemoteTest` in this configuration, replacing any existing values
`abstract void`	`setTestInvocationListener(ITestInvocationListener listener)` Convenience method to set a single `ITestInvocationListener`
`abstract void`	`setTestInvocationListeners( listeners)` Set the list of `ITestInvocationListener`s, replacing any existing values
`abstract void`	`setTests( tests)` Set the list of `IRemoteTest`s in this configuration, replacing any existing values
`abstract void`	`validateOptions()` Validate option values.

Public methods

addFilesToClean

public abstract void addFilesToClean ( toBeCleaned)

Add files that must be cleaned during cleanConfigurationData()

Parameters
`toBeCleaned`

cleanConfigurationData

public abstract void cleanConfigurationData ()

Delete any files that was downloaded to resolved Option fields of remote files.

clone

public abstract IConfiguration clone ()

Create a shallow copy of this object.

Returns
`IConfiguration`	a {link IConfiguration} copy

dumpXml

public abstract void dumpXml (PrintWriter output)

Gets the expanded XML file for the config with all options shown for this IConfiguration as a String.

Parameters
`output`	`PrintWriter`: the writer to print the xml to.

Throws
	IOException

dumpXml

public abstract void dumpXml (PrintWriter output, 
                 excludeFilters)

Gets the expanded XML file for the config with all options shown for this IConfiguration minus the objects filters by their key name.

Filter example: Configuration.TARGET_PREPARER_TYPE_NAME.

Parameters
`output`	`PrintWriter`: the writer to print the xml to.
`excludeFilters`	: the list of object type that should not be dumped.

Throws
	IOException

dumpXml

public abstract void dumpXml (PrintWriter output, 
                 excludeFilters, 
                boolean printDeprecatedOptions, 
                boolean printUnchangedOptions)

Gets the expanded XML file for the config with all options shown for this IConfiguration minus the objects filters by their key name.

Filter example: Configuration.TARGET_PREPARER_TYPE_NAME.

Parameters
`output`	`PrintWriter`: the writer to print the xml to.
`excludeFilters`	: the list of object type that should not be dumped.
`printDeprecatedOptions`	`boolean`: Whether or not to print options marked as deprecated
`printUnchangedOptions`	`boolean`

Throws
	IOException

getAllConfigurationObjectsOfType

public abstract  getAllConfigurationObjectsOfType (String typeName)

Generic interface to get all the object of one given type name across devices.

Parameters
`typeName`	`String`: the unique type of the configuration object

Returns
	The list of configuration objects of the given type.

getBuildProvider

public abstract IBuildProvider getBuildProvider ()

Gets the IBuildProvider from the configuration.

Returns
`IBuildProvider`	the `IBuildProvider` provided in the configuration

getCommandLine

public abstract String getCommandLine ()

Gets the command line used to create this IConfiguration.

Returns
`String`	the command line used to create this `IConfiguration`.

getCommandOptions

public abstract ICommandOptions getCommandOptions ()

Gets the ICommandOptions to use from the configuration.

Returns
`ICommandOptions`	the `ICommandOptions` provided in the configuration.

getConfigurationDescription

public abstract ConfigurationDescriptor getConfigurationDescription ()

Returns the ConfigurationDescriptor provided in the configuration.

Returns
`ConfigurationDescriptor`

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Generic interface to get the configuration object with the given type name.

Parameters
`typeName`	`String`: the unique type of the configuration object

Returns
`Object`	the configuration object or `null` if the object type with given name does not exist.

getConfigurationObjectList

public abstract  getConfigurationObjectList (String typeName)

Similar to getConfigurationObject(String), but for configuration object types that support multiple objects.

Parameters
`typeName`	`String`: the unique type name of the configuration object

Returns
	the list of configuration objects or `null` if the object type with given name does not exist.

getCoverageOptions

public abstract CoverageOptions getCoverageOptions ()

Gets the CoverageOptions to use from the configuration.

Returns
`CoverageOptions`	the `CoverageOptions` provided in the configuration.

getDeviceConfig

public abstract  getDeviceConfig ()

Gets the IDeviceConfigurations from the configuration.

Returns
	the `IDeviceConfiguration`s provided in order in the configuration

getDeviceConfigByName

public abstract IDeviceConfiguration getDeviceConfigByName (String nameDevice)

Return the IDeviceConfiguration associated to the name provided, null if not found.

Parameters
`nameDevice`	`String`

Returns
`IDeviceConfiguration`

getDeviceOptions

public abstract TestDeviceOptions getDeviceOptions ()

Gets the TestDeviceOptions to use from the configuration.

Returns
`TestDeviceOptions`	the `TestDeviceOptions` provided in the configuration.

getDeviceRecovery

public abstract IDeviceRecovery getDeviceRecovery ()

Gets the IDeviceRecovery to use from the configuration.

Returns
`IDeviceRecovery`	the `IDeviceRecovery` provided in the configuration.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Gets the IDeviceSelection to use from the configuration.

Returns
`IDeviceSelection`	the `IDeviceSelection` provided in the configuration.

getFilesToClean

public abstract  getFilesToClean ()

Get the list of files that will be cleaned during cleanConfigurationData()

Returns

getGlobalFilters

public abstract GlobalTestFilter getGlobalFilters ()

Gets the GlobalTestFilter for the invocation.

Returns
`GlobalTestFilter`

getInopOptions

public abstract  getInopOptions ()

Get the option names that did not change any values

Returns

getLabPreparers

public abstract  getLabPreparers ()

Gets the ITargetPreparers from the configuration.

Returns
	the `ITargetPreparer`s provided in order in the configuration

getLogOutput

public abstract ILeveledLogOutput getLogOutput ()

Gets the ILeveledLogOutput to use from the configuration.

Returns
`ILeveledLogOutput`	the `ILeveledLogOutput` provided in the configuration.

getLogSaver

public abstract ILogSaver getLogSaver ()

Gets the ILogSaver to use from the configuration.

Returns
`ILogSaver`	the `ILogSaver` provided in the configuration.

getMetricCollectors

public abstract  getMetricCollectors ()

Gets the IMetricCollectors from the configuration.

Returns

getMultiPreTargetPreparers

public abstract  getMultiPreTargetPreparers ()

Gets the IMultiTargetPreparers from the configuration that should be executed before any of the devices target_preparers.

Returns
	the `IMultiTargetPreparer`s provided in order in the configuration

getMultiTargetPreparers

public abstract  getMultiTargetPreparers ()

Gets the IMultiTargetPreparers from the configuration.

Returns
	the `IMultiTargetPreparer`s provided in order in the configuration

getName

public abstract String getName ()

Returns the name of the configuration.

Returns
`String`

getPostProcessors

public abstract  getPostProcessors ()

Gets the IPostProcessors from the configuration.

Returns

getRetryDecision

public abstract IRetryDecision getRetryDecision ()

Returns the IRetryDecision used for the invocation.

Returns
`IRetryDecision`

getSkipManager

public abstract SkipManager getSkipManager ()

Gets the SkipManager for the invocation.

Returns
`SkipManager`

getSystemStatusCheckers

public abstract  getSystemStatusCheckers ()

Gets the ISystemStatusCheckers from the configuration.

Returns
	the `ISystemStatusChecker`s provided in order in the configuration

getTargetPreparers

public abstract  getTargetPreparers ()

Gets the ITargetPreparers from the configuration.

Returns
	the `ITargetPreparer`s provided in order in the configuration

getTestInvocationListeners

public abstract  getTestInvocationListeners ()

Gets the ITestInvocationListeners to use from the configuration.

Returns
	the `ITestInvocationListener`s provided in the configuration.

getTests

public abstract  getTests ()

Gets the IRemoteTests to run from the configuration.

Returns
	the tests provided in the configuration

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Inject a option value into the set of configuration objects.

Useful to provide values for options that are generated dynamically.

Parameters
`optionName`	`String`: the option name
`optionValue`	`String`: the option value

Throws
`ConfigurationException`	if failed to set the option's value

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionKey, 
                String optionValue)

Inject a option value into the set of configuration objects.

Useful to provide values for options that are generated dynamically.

Parameters
`optionName`	`String`: the option name
`optionKey`	`String`: the optional key for map options, or null
`optionValue`	`String`: the map option value

Throws
`ConfigurationException`	if failed to set the option's value

injectOptionValueWithSource

public abstract void injectOptionValueWithSource (String optionName, 
                String optionKey, 
                String optionValue, 
                String optionSource)

Inject a option value into the set of configuration objects.

Useful to provide values for options that are generated dynamically.

Parameters
`optionName`	`String`: the option name
`optionKey`	`String`: the optional key for map options, or null
`optionValue`	`String`: the map option value
`optionSource`	`String`: the source config that provided this option value

Throws
`ConfigurationException`	if failed to set the option's value

injectOptionValues

public abstract void injectOptionValues ( optionDefs)

Inject multiple option values into the set of configuration objects.

Useful to inject many option values at once after creating a new object.

Parameters
`optionDefs`	: a list of option defs to inject

Throws
`ConfigurationException`	if failed to set option values

isDeviceConfiguredFake

public abstract boolean isDeviceConfiguredFake (String deviceName)

Returns whether or not a configured device is tagged isFake=true or not.

Parameters
`deviceName`	`String`

Returns
`boolean`

partialDeepClone

public abstract IConfiguration partialDeepClone ( objectToDeepClone, 
                IKeyStoreClient client)

Create a base clone from clone() then deep clone the list of given config object.

Parameters
`objectToDeepClone`	: The list of configuration object to deep clone.
`client`	`IKeyStoreClient`: The keystore client.

Returns
`IConfiguration`	The partially deep cloned config.

Throws
	com.android.tradefed.config.ConfigurationException
`ConfigurationException`

printCommandUsage

public abstract void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Outputs a command line usage help text for this configuration to given printStream.

Parameters
`importantOnly`	`boolean`: if `true` only print help for the important options
`out`	`PrintStream`: the `ERROR(/PrintStream)` to use.

Throws
	com.android.tradefed.config.ConfigurationException
`ConfigurationException`

resolveDynamicOptions

public abstract void resolveDynamicOptions (DynamicRemoteFileResolver resolver)

Resolve options of ERROR(/File) pointing to a remote location. This requires cleanConfigurationData() to be called to clean up the files.

Parameters
`resolver`	`DynamicRemoteFileResolver`: the `DynamicRemoteFileResolver` to resolve the files

Throws
	com.android.tradefed.build.BuildRetrievalError
	com.android.tradefed.config.ConfigurationException
`BuildRetrievalError`
`ConfigurationException`

safeInjectOptionValues

public abstract void safeInjectOptionValues ( optionDefs)

Inject multiple option values into the set of configuration objects without throwing if one of the option cannot be applied.

Useful to inject many option values at once after creating a new object.

Parameters
`optionDefs`	: a list of option defs to inject

Throws
`ConfigurationException`	if failed to create the `OptionSetter`

setBestEffortOptionsFromCommandLineArgs

public abstract  setBestEffortOptionsFromCommandLineArgs ( listArgs, 
                IKeyStoreClient keyStoreClient)

Set the config Option fields with given set of command line arguments using a best effort approach.

See ArgsOptionParser for expected format

Parameters
`listArgs`	: the command line arguments
`keyStoreClient`	`IKeyStoreClient`: `IKeyStoreClient` to use.

Returns
	the unconsumed arguments

Throws
`ConfigurationException`

setBuildProvider

public abstract void setBuildProvider (IBuildProvider provider)

Replace the current IBuildProvider in the configuration.

Parameters
`provider`	`IBuildProvider`: the new `IBuildProvider`

setCommandLine

public abstract void setCommandLine (String[] arrayArgs)

Sets the command line used to create this IConfiguration. This stores the whole command line, including the configuration name, unlike setOptionsFromCommandLineArgs.

Parameters
`arrayArgs`	`String`: the command line

setCommandOptions

public abstract void setCommandOptions (ICommandOptions cmdOptions)

Set the ICommandOptions, replacing any existing values

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

Generic method to set the config object with the given name, replacing any existing value.

Parameters
`name`	`String`: the unique name of the config object type.
`configObject`	`Object`: the config object

Throws
`ConfigurationException`	if the configObject was not the correct type

setConfigurationObjectList

public abstract void setConfigurationObjectList (String name, 
                 configList)

Generic method to set the config object list for the given name, replacing any existing value.

Parameters
`name`	`String`: the unique name of the config object type.
`configList`	: the config object list

Throws
`ConfigurationException`	if any objects in the list are not the correct type

setCoverageOptions

public abstract void setCoverageOptions (CoverageOptions coverageOptions)

Set the CoverageOptions, replacing any existing values.

Parameters
`coverageOptions`	`CoverageOptions`

setDeviceConfig

public abstract void setDeviceConfig (IDeviceConfiguration deviceConfig)

Set a IDeviceConfiguration, replacing any existing value.

setDeviceConfigList

public abstract void setDeviceConfigList ( deviceConfigs)

Set the IDeviceConfigurations, replacing any existing value.

setDeviceMetricCollectors

public abstract void setDeviceMetricCollectors ( collectors)

Set the list of IMetricCollectors, replacing any existing values.

Parameters
`collectors`

setDeviceOptions

public abstract void setDeviceOptions (TestDeviceOptions deviceOptions)

Set the TestDeviceOptions, replacing any existing values

Parameters
`deviceOptions`	`TestDeviceOptions`

setDeviceRecovery

public abstract void setDeviceRecovery (IDeviceRecovery recovery)

Set the IDeviceRecovery, replacing any existing value.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Set the IDeviceSelection, replacing any existing values

setLabPreparer

public abstract void setLabPreparer (ITargetPreparer preparer)

Set the ITargetPreparer, replacing any existing value.

setLabPreparers

public abstract void setLabPreparers ( preparers)

Set the list of ITargetPreparers, replacing any existing value.

setLogOutput

public abstract void setLogOutput (ILeveledLogOutput logger)

Set the ILeveledLogOutput, replacing any existing value.

setLogSaver

public abstract void setLogSaver (ILogSaver logSaver)

Set the ILogSaver, replacing any existing value.

setMultiPreTargetPreparer

public abstract void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPreps)

Convenience method to set a single IMultiTargetPreparer in this configuration that should be executed before any of the devices target_preparers, replacing any existing values

setMultiPreTargetPreparers

public abstract void setMultiPreTargetPreparers ( multiPreTargPreps)

Set the list of IMultiTargetPreparers in this configuration that should be executed before any of the devices target_preparers, replacing any existing values

setMultiTargetPreparer

public abstract void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)

Convenience method to set a single IMultiTargetPreparer in this configuration, replacing any existing values

setMultiTargetPreparers

public abstract void setMultiTargetPreparers ( multiTargPreps)

Set the list of IMultiTargetPreparers in this configuration, replacing any existing values

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Set the config Option fields with given set of command line arguments

ArgsOptionParser for expected format

Parameters
`listArgs`	: the command line arguments

Returns
	the unconsumed arguments

Throws
`ConfigurationException`

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs, 
                IKeyStoreClient keyStoreClient)

Set the config Option fields with given set of command line arguments

See ArgsOptionParser for expected format

Parameters
`listArgs`	: the command line arguments
`keyStoreClient`	`IKeyStoreClient`: `IKeyStoreClient` to use.

Returns
	the unconsumed arguments

Throws
`ConfigurationException`

setPostProcessors

public abstract void setPostProcessors ( processors)

Set the list of IPostProcessors, replacing any existing values.

Parameters
`processors`

setRetryDecision

public abstract void setRetryDecision (IRetryDecision decisionRetry)

Set the IRetryDecision, replacing any existing value.

setSystemStatusChecker

public abstract void setSystemStatusChecker (ISystemStatusChecker systemChecker)

Convenience method to set a single ISystemStatusChecker in this configuration, replacing any existing values

setSystemStatusCheckers

public abstract void setSystemStatusCheckers ( systemCheckers)

Set the list of ISystemStatusCheckers in this configuration, replacing any existing values

setTargetPreparer

public abstract void setTargetPreparer (ITargetPreparer preparer)

Set the ITargetPreparer, replacing any existing value.

setTargetPreparers

public abstract void setTargetPreparers ( preparers)

Set the list of ITargetPreparers, replacing any existing value.

setTest

public abstract void setTest (IRemoteTest test)

Convenience method to set a single IRemoteTest in this configuration, replacing any existing values

setTestInvocationListener

public abstract void setTestInvocationListener (ITestInvocationListener listener)

Convenience method to set a single ITestInvocationListener

setTestInvocationListeners

public abstract void setTestInvocationListeners ( listeners)

Set the list of ITestInvocationListeners, replacing any existing values

setTests

public abstract void setTests ( tests)

Set the list of IRemoteTests in this configuration, replacing any existing values

validateOptions

public abstract void validateOptions ()

Validate option values.

Currently this will just validate that all mandatory options have been set

Throws
`ConfigurationException`	if config is not valid