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.

IDeviceBuildInfo

public interface IDeviceBuildInfo
implements IBuildInfo

com.android.tradefed.build.IDeviceBuildInfo

Known indirect subclasses

AppDeviceBuildInfo, ClusterBuildInfo, DeviceBuildInfo, DeviceFolderBuildInfo, OtaDeviceBuildInfo

AppDeviceBuildInfo	This class is deprecated. Use `IDeviceBuildInfo` directly.
ClusterBuildInfo	A `IBuildInfo` class for builds piped from TFC.
DeviceBuildInfo	A `IBuildInfo` that represents a complete Android device build and (optionally) its tests.
DeviceFolderBuildInfo	A `IDeviceBuildInfo` that also contains other build artifacts contained in a directory on the local filesystem.
OtaDeviceBuildInfo	A `IDeviceBuildInfo` used for over-the-air update testing.

A IBuildInfo that represents a complete Android device build and (optionally) its tests.

Summary

Public methods
`abstract void`	`cleanUp()` Removes all temporary files.
`abstract File`	`getBasebandImageFile()` Get the local baseband image file.
`abstract String`	`getBasebandVersion()` Get the baseband version.
`abstract File`	`getBootloaderImageFile()` Get the local bootloader image file.
`abstract String`	`getBootloaderVersion()` Get the bootloader version.
`abstract String`	`getDeviceBuildFlavor()` Optional method to return the type of the platform build being tested.
`abstract String`	`getDeviceBuildId()` Returns the unique identifier of platform build under test.
`abstract File`	`getDeviceImageFile()` Get the local device image zip file.
`abstract String`	`getDeviceImageVersion()` Get the local device image zip version.
`abstract File`	`getMkbootimgFile()` Gets the mkbootimg file used to create the kernel image.
`abstract String`	`getMkbootimgVersion()` Gets the mkbootimg version.
`abstract File`	`getOtaPackageFile()` Get the device OTA package zip file.
`abstract String`	`getOtaPackageVersion()` Get the device OTA package zip version.
`abstract File`	`getRamdiskFile()` Gets the ramdisk file used to create the kernel image.
`abstract String`	`getRamdiskVersion()` Gets the ramdisk version.
`default File`	`getResourcesDir()` Returns the dir containing some of the downloaded resources.
`abstract File`	`getTestsDir()` Get the local path to the extracted tests.zip file contents.
`abstract String`	`getTestsDirVersion()` Get the extracted tests.zip version.
`abstract File`	`getUserDataImageFile()` Get the local test userdata image file.
`abstract String`	`getUserDataImageVersion()` Get the local test userdata image version.
`abstract void`	`setBasebandImage(File basebandFile, String version)` Set the baseband image for the device build.
`abstract void`	`setBootloaderImageFile(File bootloaderImgFile, String version)` Set the bootloader image for the device build.
`default void`	`setDeviceBuildFlavor(String deviceBuildFlavor)` Set the build-flavor for the device part of the build info if different from `IBuildInfo.setBuildFlavor(String)`.
`abstract void`	`setDeviceImageFile(File deviceImageFile, String version)` Set the device system image file to use.
`abstract void`	`setMkbootimgFile(File mkbootimg, String version)` Sets the mkbootimg file used to create the kernel image.
`abstract void`	`setOtaPackageFile(File otaFile, String version)` Set the device OTA package zip file.
`abstract void`	`setRamdiskFile(File ramdisk, String version)` Gets the ramdisk file used to create the kernel image.
`default void`	`setResourcesDir(File resourcesDir, String version)` Sets the resources directory `ERROR(/File)`.
`abstract void`	`setTestsDir(File testsZipFile, String version)` Set local path to the extracted tests.zip file contents.
`abstract void`	`setUserDataImageFile(File userDataFile, String version)` Set the user data image file to use.

Public methods

cleanUp

public abstract void cleanUp ()

Removes all temporary files.

getBasebandImageFile

public abstract File getBasebandImageFile ()

Get the local baseband image file.

Returns
`File`

getBasebandVersion

public abstract String getBasebandVersion ()

Get the baseband version.

Returns
`String`

getBootloaderImageFile

public abstract File getBootloaderImageFile ()

Get the local bootloader image file.

Returns
`File`

getBootloaderVersion

public abstract String getBootloaderVersion ()

Get the bootloader version.

Returns
`String`

getDeviceBuildFlavor

public abstract String getDeviceBuildFlavor ()

Optional method to return the type of the platform build being tested.

Returns
`String`

getDeviceBuildId

public abstract String getDeviceBuildId ()

Returns the unique identifier of platform build under test. Should never be null. Defaults to IBuildInfo.UNKNOWN_BUILD_ID.

Returns
`String`

getDeviceImageFile

public abstract File getDeviceImageFile ()

Get the local device image zip file.

Returns
`File`

getDeviceImageVersion

public abstract String getDeviceImageVersion ()

Get the local device image zip version.

Returns
`String`

getMkbootimgFile

public abstract File getMkbootimgFile ()

Gets the mkbootimg file used to create the kernel image.

Returns
`File`

getMkbootimgVersion

public abstract String getMkbootimgVersion ()

Gets the mkbootimg version.

Returns
`String`

getOtaPackageFile

public abstract File getOtaPackageFile ()

Get the device OTA package zip file.

Returns
`File`

getOtaPackageVersion

public abstract String getOtaPackageVersion ()

Get the device OTA package zip version.

Returns
`String`

getRamdiskFile

public abstract File getRamdiskFile ()

Gets the ramdisk file used to create the kernel image.

Returns
`File`

getRamdiskVersion

public abstract String getRamdiskVersion ()

Gets the ramdisk version.

Returns
`String`

getResourcesDir

public File getResourcesDir ()

Returns the dir containing some of the downloaded resources. (Resources are usually associated with a isFake=true device definition). Returns null if no resource dir available.

Returns
`File`

getTestsDir

public abstract File getTestsDir ()

Get the local path to the extracted tests.zip file contents.

Returns
`File`

getTestsDirVersion

public abstract String getTestsDirVersion ()

Get the extracted tests.zip version.

Returns
`String`

getUserDataImageFile

public abstract File getUserDataImageFile ()

Get the local test userdata image file.

Returns
`File`

getUserDataImageVersion

public abstract String getUserDataImageVersion ()

Get the local test userdata image version.

Returns
`String`

setBasebandImage

public abstract void setBasebandImage (File basebandFile, 
                String version)

Set the baseband image for the device build.

Parameters
`basebandFile`	`File`: the baseband image `ERROR(/File)`
`version`	`String`: the version of the baseband

setBootloaderImageFile

public abstract void setBootloaderImageFile (File bootloaderImgFile, 
                String version)

Set the bootloader image for the device build.

Parameters
`bootloaderImgFile`	`File`: the bootloader image `ERROR(/File)`
`version`	`String`: the version of the bootloader

setDeviceBuildFlavor

public void setDeviceBuildFlavor (String deviceBuildFlavor)

Set the build-flavor for the device part of the build info if different from IBuildInfo.setBuildFlavor(String).

Parameters
`deviceBuildFlavor`	`String`: Flavor of the device build

setDeviceImageFile

public abstract void setDeviceImageFile (File deviceImageFile, 
                String version)

Set the device system image file to use.

Parameters
`version`	`String`

setMkbootimgFile

public abstract void setMkbootimgFile (File mkbootimg, 
                String version)

Sets the mkbootimg file used to create the kernel image.

Parameters
`mkbootimg`	`File`
`version`	`String`

setOtaPackageFile

public abstract void setOtaPackageFile (File otaFile, 
                String version)

Set the device OTA package zip file.

Parameters
`otaFile`	`File`
`version`	`String`

setRamdiskFile

public abstract void setRamdiskFile (File ramdisk, 
                String version)

Gets the ramdisk file used to create the kernel image.

Parameters
`ramdisk`	`File`
`version`	`String`

setResourcesDir

public void setResourcesDir (File resourcesDir, 
                String version)

Sets the resources directory ERROR(/File).

Parameters
`resourcesDir`	`File`: The directory containing the shared resources.
`version`	`String`: The version of the directory file.

setTestsDir

public abstract void setTestsDir (File testsZipFile, 
                String version)

Set local path to the extracted tests.zip file contents.

Parameters
`version`	`String`

setUserDataImageFile

public abstract void setUserDataImageFile (File userDataFile, 
                String version)

Set the user data image file to use.

Parameters
`version`	`String`