IDeviceFlasher

public interface IDeviceFlasher

com.android.tradefed.targetprep.IDeviceFlasher
Known Indirect Subclasses
CdmaDeviceFlasher A class that flashes an image on a physical Android device with a CDMA radio. 
FastbootDeviceFlasher A class that relies on fastboot to flash an image on physical Android hardware. 
SystemUpdaterDeviceFlasher A IDeviceFlasher that relies on the system updater to install a system image bundled in a OTA update package. 


Flashes a device image on a device.

Summary

Nested classes

enum IDeviceFlasher.UserDataFlashOption

Enum of options for handling the userdata image  

Public methods

abstract void flash(ITestDevice device, IDeviceBuildInfo deviceBuild)

Flashes build on device.

abstract IDeviceFlasher.UserDataFlashOption getUserDataFlashOption()

Gets whether the user data image should be flashed, wiped, or retained

abstract void overrideDeviceOptions(ITestDevice device)

Override options for a device.

abstract void setDataWipeSkipList(Collection<String> dataWipeSkipList)

Sets the list of paths under /data to avoid clearing when using ITestsZipInstaller

Note that the granularity of the skip list is direct children of /data.

abstract void setFlashingResourcesRetriever(IFlashingResourcesRetriever retriever)

Sets the mechanism by which the flasher can retrieve resource files for flashing.

abstract void setForceSystemFlash(boolean forceSystemFlash)

Sets if system should always be flashed even if running current build

abstract void setUserDataFlashOption(IDeviceFlasher.UserDataFlashOption flashOption)

Toggles whether the user data image should be flashed, wiped, or retained

abstract void setWipeTimeout(long timeout)

Set the timeout for wiping the data.

Public methods

flash

void flash (ITestDevice device, 
                IDeviceBuildInfo deviceBuild)

Flashes build on device.

Returns immediately after flashing is complete. Callers should wait for device to be online and available before proceeding with testing.

Parameters
device ITestDevice: the ITestDevice to flash

deviceBuild IDeviceBuildInfo: the IDeviceBuildInfo to flash

Throws
TargetSetupError if failed to flash build
DeviceNotAvailableException if device becomes unresponsive

getUserDataFlashOption

IDeviceFlasher.UserDataFlashOption getUserDataFlashOption ()

Gets whether the user data image should be flashed, wiped, or retained

Returns
IDeviceFlasher.UserDataFlashOption Whether the user data image should be flashed, wiped, or retained

overrideDeviceOptions

void overrideDeviceOptions (ITestDevice device)

Override options for a device. Used to override default option values if the defaults are not supported by a particular device.

setDataWipeSkipList

void setDataWipeSkipList (Collection<String> dataWipeSkipList)

Sets the list of paths under /data to avoid clearing when using ITestsZipInstaller

Note that the granularity of the skip list is direct children of /data.

Parameters
dataWipeSkipList Collection

setFlashingResourcesRetriever

void setFlashingResourcesRetriever (IFlashingResourcesRetriever retriever)

Sets the mechanism by which the flasher can retrieve resource files for flashing.

Parameters
retriever IFlashingResourcesRetriever: the IFlashingResourcesRetriever to use

setForceSystemFlash

void setForceSystemFlash (boolean forceSystemFlash)

Sets if system should always be flashed even if running current build

setUserDataFlashOption

void setUserDataFlashOption (IDeviceFlasher.UserDataFlashOption flashOption)

Toggles whether the user data image should be flashed, wiped, or retained

setWipeTimeout

void setWipeTimeout (long timeout)

Set the timeout for wiping the data.

Parameters
timeout long