public interface

IGlobalConfiguration

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

Class Overview

A class to encompass global configuration information for a single Trade Federation instance (encompassing any number of invocations of actual configurations).

Summary

Public Methods
abstract IDeviceMonitor getDeviceMonitor()
Gets the IDeviceMonitor from the global config.
abstract IDeviceSelection getDeviceRequirements()
Gets the IDeviceSelection to use from the configuration.
abstract void injectOptionValue(String optionName, String optionKey, String optionValue)
Inject a option value into the set of configuration objects.
abstract void injectOptionValue(String optionName, String optionValue)
Inject a option value into the set of configuration objects.
abstract void setConfigurationObjectList(String typeName, List<?> configList)
Generic method to set the config object list for the given name, replacing any existing value.
abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)
abstract void setDeviceRequirements(IDeviceSelection deviceSelection)
Set the IDeviceSelection, replacing any existing values.
abstract List<String> setOptionsFromCommandLineArgs(List<String> listArgs)
Set the global config Option fields with given set of command line arguments

Public Methods

public abstract IDeviceMonitor getDeviceMonitor ()

Gets the IDeviceMonitor from the global config.

Returns
  • the IDeviceMonitor from the global config, or null if none was specified.

public abstract IDeviceSelection getDeviceRequirements ()

Gets the IDeviceSelection to use from the configuration. Represents a global filter on which devices the DeviceManager can see.

Returns

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 the map option name
optionKey the map option key
optionValue the map option value
Throws
ConfigurationException if failed to set the option's value

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 the option name
optionValue the option value(s)
Throws
ConfigurationException if failed to set the option's value

public abstract void setConfigurationObjectList (String typeName, List<?> configList)

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

Parameters
typeName 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

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Parameters
deviceMonitor The monitor
Throws
ConfigurationException if an IDeviceMonitor has already been set.

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Set the IDeviceSelection, replacing any existing values. This sets a global device filter on which devices the DeviceManager can see.

public abstract List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

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

Parameters
listArgs the command line arguments
Returns
  • the unconsumed arguments