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.

IDeviceConfiguration

public interface IDeviceConfiguration

com.android.tradefed.config.IDeviceConfiguration

Known indirect subclasses

DeviceConfigurationHolder

DeviceConfigurationHolder A concrete IDeviceConfiguration implementation that stores the loaded device configuration objects in its attributes.

Device Configuration Holder Interface. Use to represent an object that can hold the information for the configuration of a device.

Summary

Public methods
`abstract void`	`addFrequency(Object config, Integer frequency)` Keep track of the frequency of the object so we can properly inject option against it.
`abstract void`	`addSpecificConfig(Object config, String type)` Pass one of the allowed objects that the Configuration Holder can keep track of.
`abstract void`	`addSpecificConfig(Object config)` Pass one of the allowed objects that the Configuration Holder can keep track of.
`abstract IDeviceConfiguration`	`clone(String newName)` Return a shallow copy of this `IDeviceConfiguration` object, under a new name.
`abstract IDeviceConfiguration`	`clone()` Return a shallow copy of this `IDeviceConfiguration` object.
`abstract`	`getAllObjectOfType(String configType)` Return The list of all the configuration objects held the instance of `IDeviceConfiguration` that match the configuration type requested.
`abstract`	`getAllObjects()` Return The list of all the configuration objects held the instance of `IDeviceConfiguration`
`abstract IBuildProvider`	`getBuildProvider()` Return `IBuildProvider` that the device configuration holder has reference to.
`abstract String`	`getDeviceName()` Returns The Name of the device specified in the field "name" of the configuration.
`abstract TestDeviceOptions`	`getDeviceOptions()` Return `TestDeviceOptions` that the device configuration holder has.
`abstract IDeviceRecovery`	`getDeviceRecovery()` Return `IDeviceRecovery` that the device configuration holder has.
`abstract IDeviceSelection`	`getDeviceRequirements()` Return `IDeviceSelection` that the device configuration holder has.
`abstract Integer`	`getFrequency(Object config)` Returns the frequency of the object.
`abstract`	`getLabPreparers()` Return a list of `ITargetPreparer` that the device configuration holder has.
`abstract`	`getTargetPreparers()` Return a list of `ITargetPreparer` that the device configuration holder has.
`abstract boolean`	`isFake()` Returns whether the container is for a Device Under Test or not.
`abstract void`	`removeObjectType(String type)` Remove the specified object type from the device configuration holder.

Public methods

addFrequency

public abstract void addFrequency (Object config, 
                Integer frequency)

Keep track of the frequency of the object so we can properly inject option against it.

Parameters
`config`	`Object`: the object we are tracking the frequency.
`frequency`	`Integer`: frequency associated with the object.

addSpecificConfig

public abstract void addSpecificConfig (Object config, 
                String type)

Pass one of the allowed objects that the Configuration Holder can keep track of.

Complete list of allowed objects are: IBuildProvider, ITargetPreparer, IDeviceRecovery, IDeviceSelection, TestDeviceOptions

Parameters
`config`	`Object`: object from a type above.
`type`	`String`: the type of configuration object being passed.

Throws
`ConfigurationException`	in case the object passed doesn't match the allowed types.

addSpecificConfig

public abstract void addSpecificConfig (Object config)

Pass one of the allowed objects that the Configuration Holder can keep track of.

Complete list of allowed objects are: IBuildProvider, ITargetPreparer, IDeviceRecovery, IDeviceSelection, TestDeviceOptions

Parameters
`config`	`Object`: object from a type above.

Throws
`ConfigurationException`	in case the object passed doesn't match the allowed types.

clone

public abstract IDeviceConfiguration clone (String newName)

Return a shallow copy of this IDeviceConfiguration object, under a new name.

Parameters
`newName`	`String`

Returns
`IDeviceConfiguration`

clone

public abstract IDeviceConfiguration clone ()

Return a shallow copy of this IDeviceConfiguration object.

Returns
`IDeviceConfiguration`

getAllObjectOfType

public abstract  getAllObjectOfType (String configType)

Return The list of all the configuration objects held the instance of IDeviceConfiguration that match the configuration type requested.

Parameters
`configType`	`String`

Returns

getAllObjects

public abstract  getAllObjects ()

Return The list of all the configuration objects held the instance of IDeviceConfiguration

Returns

getBuildProvider

public abstract IBuildProvider getBuildProvider ()

Return IBuildProvider that the device configuration holder has reference to.

Returns
`IBuildProvider`

getDeviceName

public abstract String getDeviceName ()

Returns The Name of the device specified in the field "name" of the configuration.

Returns
`String`

getDeviceOptions

public abstract TestDeviceOptions getDeviceOptions ()

Return TestDeviceOptions that the device configuration holder has.

Returns
`TestDeviceOptions`

getDeviceRecovery

public abstract IDeviceRecovery getDeviceRecovery ()

Return IDeviceRecovery that the device configuration holder has.

Returns
`IDeviceRecovery`

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Return IDeviceSelection that the device configuration holder has.

Returns
`IDeviceSelection`

getFrequency

public abstract Integer getFrequency (Object config)

Returns the frequency of the object.

Parameters
`config`	`Object`

Returns
`Integer`

getLabPreparers

public abstract  getLabPreparers ()

Return a list of ITargetPreparer that the device configuration holder has.

Returns

getTargetPreparers

public abstract  getTargetPreparers ()

Return a list of ITargetPreparer that the device configuration holder has.

Returns

isFake

public abstract boolean isFake ()

Returns whether the container is for a Device Under Test or not.

Returns
`boolean`

removeObjectType

public abstract void removeObjectType (String type)

Remove the specified object type from the device configuration holder.

Parameters
`type`	`String`: The type of the object to remove.

Throws
`ConfigurationException`	in case the type is not supported.