自 2025 年 3 月 27 日起，我們建議您使用 android-latest-release 而非 aosp-main 建構及貢獻 AOSP。詳情請參閱「Android 開放原始碼計畫變更」。

本頁面由 Cloud Translation API 翻譯而成。

IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

已知間接子類別

AppBuildInfo、AppDeviceBuildInfo、BuildInfo、ClusterBuildInfo、DeviceBuildInfo、DeviceFolderBuildInfo、FolderBuildInfo、IAppBuildInfo、IDeviceBuildInfo、IFolderBuildInfo、OtaDeviceBuildInfo、OtatoolsBuildInfo

AppBuildInfo	代表 Android 應用程式及其測試套件的 `IBuildInfo`。
AppDeviceBuildInfo	這個類別已淘汰。直接使用 `IDeviceBuildInfo`。
BuildInfo	應與 `ITestDevice` 相關聯的 `IBuildInfo` 一般實作項目。
ClusterBuildInfo	用於從 TFC 管道傳送的版本的 `IBuildInfo` 類別。
DeviceBuildInfo	代表完整 Android 裝置版本和 (選用) 其測試的 `IBuildInfo`。
DeviceFolderBuildInfo	`IDeviceBuildInfo` 也包含本機檔案系統目錄中的其他建構構件。
FolderBuildInfo	具體實作 `IFolderBuildInfo`。
IAppBuildInfo	此介面已淘汰。直接使用 `IBuildInfo`。
IDeviceBuildInfo	代表完整 Android 裝置版本和 (選用) 其測試的 `IBuildInfo`。
IFolderBuildInfo	簡單的抽象 `IBuildInfo`，其建構構件包含在本機檔案系統目錄中。
OtaDeviceBuildInfo	用於無線更新測試的 `IDeviceBuildInfo`。
OtatoolsBuildInfo	包含 otatools 構建物的 `IBuildInfo`。

保存測試中版本的相關資訊。

摘要

常數
`String`	`REMOTE_FILE_PREFIX` 名稱中使用的前置字串，用來表示檔案已設為延遲下載。
`String`	`REMOTE_FILE_VERSION` 遠端檔案未經過版本控制。
`String`	`UNKNOWN_BUILD_ID` 當未知曉版本 ID 時的預設值。

公用方法
`default void`	`addAppPackageFile(File appPackageFile, String version)` 新增本機 APK 檔案及其相關版本。
`abstract void`	`addBuildAttribute(String attributeName, String attributeValue)` 新增建構屬性。
`default void`	`addBuildAttributes( buildAttributes)` 新增建構屬性
`default void`	`allowStagingRemoteFile(boolean stageRemoteFile)` 設定權限，允許布建遠端檔案。
`abstract void`	`cleanUp()` 清理任何暫存的建構檔案
`abstract void`	`cleanUp( doNotDelete)` `cleanUp()` 的版本，其中部分檔案未刪除。
`abstract IBuildInfo`	`clone()` 複製 `IBuildInfo` 物件。
`default`	`getAppPackageFiles()` 取得本機應用程式 APK 檔案集合及其版本的副本。
`abstract`	`getBuildAttributes()` 取得一組額外屬性名稱/值組合，用於說明版本。
`abstract String`	`getBuildBranch()` 選用方法，用於傳回測試中產生的建構版本來源控制分支。
`abstract String`	`getBuildFlavor()` 用於傳回測試中建構類型的選用方法。
`abstract String`	`getBuildId()` 傳回測試中版本的專屬 ID。
`abstract String`	`getBuildTargetName()` 傳回測試中版本的完整名稱。
`abstract String`	`getDeviceSerial()`
`abstract File`	`getFile(String name)` 擷取指定名稱檔案的輔助方法。
`default File`	`getFile(BuildInfoKey.BuildInfoFileKey key)` 輔助方法，可透過指定的 `BuildInfoFileKey` 擷取檔案。
`abstract`	`getFiles()` 傳回儲存在這個 `BuildInfo` 中的所有 `VersionedFile`。
`abstract`	`getProperties()` 傳回目前在 `IBuildInfo` 上設定的屬性副本。
`default`	`getRemoteFiles()` 取得延遲下載的建構構件路徑。
`abstract String`	`getTestTag()` 為執行中的測試傳回專屬名稱。
`default String`	`getVersion(BuildInfoKey.BuildInfoFileKey key)` 輔助方法，可透過指定的 `BuildInfoFileKey` 擷取檔案版本。
`abstract String`	`getVersion(String name)` 用於擷取指定名稱的檔案版本的輔助方法。
`default VersionedFile`	`getVersionedFile(BuildInfoKey.BuildInfoFileKey key)` 輔助方法，可透過指定的 `BuildInfoFileKey` 擷取 `VersionedFile`。
`default VersionedFile`	`getVersionedFile(String name)` 用於擷取具有特定名稱的 `VersionedFile` 的輔助方法。
`default`	`getVersionedFileKeys()` 傳回可透過 `getFile(BuildInfoFileKey)` 查詢 `VersionedFile` 的金鑰組合。
`default`	`getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)` 輔助方法，用於擷取與指定 `BuildInfoFileKey` 相關聯的 `VersionedFile` 清單。
`default void`	`removeBuildAttribute(String attributeName)` 從追蹤中移除特定的 attributeName。
`abstract void`	`setBuildBranch(String branch)` 設定建構分支
`abstract void`	`setBuildFlavor(String buildFlavor)` 設定建構變種。
`abstract void`	`setBuildId(String buildId)` 設定測試中版本的專屬 ID。
`abstract void`	`setDeviceSerial(String serial)` 設定與此版本相關聯的 `ITestDevice` 序號。
`abstract void`	`setFile(String name, File file, String version)` 在這個建構資訊中儲存指定名稱的檔案。
`default void`	`setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)` 在這個版本資訊中儲存 `BuildInfoFileKey` 指定的檔案。
`abstract void`	`setProperties(BuildInfoProperties... properties)` 為 `IBuildInfo` 例項設定 `BuildInfoProperties`。
`abstract void`	`setTestTag(String testTag)` 為執行的測試設定不重複的名稱。
`default File`	`stageRemoteFile(String fileName, File workingDir)` 在建構資訊的根目錄中，將屬於遠端檔案的檔案設為階段檔案。
`default BuildInformation.BuildInfo`	`toProto()` 將 BuildInfo 例項序列化為 protobuf。

常數

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

名稱中使用的前置字串，用於表示檔案已設為延遲下載。

常數值： "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

遠端檔案未分版本。

常數值： ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

當未知曉版本 ID 時的預設值。

常數值： "-1"

公用方法

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

新增本機 APK 檔案及其相關版本。請注意，系統會按照透過此方法新增的順序，從 getAppPackageFiles() 傳回 APK。

參數
`appPackageFile`	`File`
`version`	`String`

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

新增建構屬性。這麼做不會覆寫現有的 attributeName。

參數
`attributeName`	`String`：不重複的屬性名稱
`attributeValue`	`String`：屬性值

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

新增建構屬性

參數
`buildAttributes`	：要新增的屬性對應

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

設定權限，允許布建遠端檔案。

參數
`stageRemoteFile`	`boolean`

cleanUp

public abstract void cleanUp ()

清理任何暫時性建構檔案

cleanUp

public abstract void cleanUp ( doNotDelete)

cleanUp() 的版本，其中部分檔案未刪除。

參數
`doNotDelete`

clone

public abstract IBuildInfo clone ()

複製 IBuildInfo 物件。

傳回
`IBuildInfo`

getAppPackageFiles

public  getAppPackageFiles ()

取得本機應用程式 APK 檔案集合及其版本的副本。傳回的順序會與 APK 新增至 IAppBuildInfo 的順序相符。

傳回

getBuildAttributes

public abstract  getBuildAttributes ()

取得一組描述版本的額外屬性名稱/值組合。

傳回
	建構屬性的 `ERROR(/Map)`。不會是 `null`，但可能會是空白。

getBuildBranch

public abstract String getBuildBranch ()

選用方法，用於傳回測試中產生版本的來源控制分支。

傳回
`String`	建構分支或 `null` (如未設定/不適用)

getBuildFlavor

public abstract String getBuildFlavor ()

用於傳回測試中建構類型的選用方法。

Android 平台建構作業的一般實作方式是傳回 (建構產品)-(建構作業系統)-(建構變化版本)。ie generic-linux-userdebug

傳回
`String`	建構版本或 `null` (如未設定/不適用)

getBuildId

public abstract String getBuildId ()

傳回測試中版本的專屬 ID。不得為空值。預設值為 UNKNOWN_BUILD_ID。

傳回
`String`

getBuildTargetName

public abstract String getBuildTargetName ()

傳回測試版本的完整名稱。

常見的實作方式是根據建構變種版本和分支名稱組合，建構建構目標名稱。[即 (分支版本名稱)-(建構口味)]

傳回
`String`

getDeviceSerial

public abstract String getDeviceSerial ()

傳回
`String`	這個版本執行的 `ITestDevice` 序列。如果沒有裝置與這個版本建立關聯，就會傳回 `null`。

getFile

public abstract File getFile (String name)

擷取指定名稱檔案的輔助方法。

傳回
`File`	圖片檔案或 `null` (如果找不到)

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

輔助方法，可透過指定 BuildInfoFileKey 擷取檔案。

參數
`key`	`BuildInfoKey.BuildInfoFileKey`：要求的 `BuildInfoFileKey`。

傳回
`File`	圖片檔案或 `null` (如果找不到)

getFiles

public abstract  getFiles ()

傳回儲存在這個 BuildInfo 中的所有 VersionedFile。

傳回

getProperties

public abstract  getProperties ()

傳回目前在 IBuildInfo 上設定的屬性副本。

傳回

getRemoteFiles

public  getRemoteFiles ()

取得延遲下載的建構構件路徑。

傳回

getTestTag

public abstract String getTestTag ()

為執行中的測試傳回專屬名稱。

傳回
`String`

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

輔助方法，可透過指定 BuildInfoFileKey 擷取檔案版本。

參數
`key`	`BuildInfoKey.BuildInfoFileKey`：要求的 `BuildInfoFileKey`。

傳回
`String`	圖片版本，如果找不到則為 `null`

getVersion

public abstract String getVersion (String name)

用於擷取指定名稱的檔案版本的輔助方法。

傳回
`String`	圖片版本，如果找不到則為 `null`

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

輔助方法，可透過指定的 BuildInfoFileKey 擷取 VersionedFile。

參數
`key`	`BuildInfoKey.BuildInfoFileKey`：要求的 `BuildInfoFileKey`。

傳回
`VersionedFile`	版本檔案或 `null` (如果找不到)

getVersionedFile

public VersionedFile getVersionedFile (String name)

用於擷取具有指定名稱的 VersionedFile 的輔助方法。

傳回
`VersionedFile`	版本檔案或 `null` (如果找不到)

getVersionedFileKeys

public  getVersionedFileKeys ()

透過 getFile(BuildInfoFileKey) 傳回可用於查詢 VersionedFile 的金鑰組合。

傳回

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

輔助方法，用於擷取與指定 BuildInfoFileKey 相關聯的 VersionedFile 清單。是否允許使用者儲存清單。

參數
`key`	`BuildInfoKey.BuildInfoFileKey`：要求的 `BuildInfoFileKey`。

傳回
	版本檔案或 `null` (如果找不到)

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

從追蹤中移除特定的 attributeName。

參數
`attributeName`	`String`：停止追蹤的屬性

setBuildBranch

public abstract void setBuildBranch (String branch)

設定建構分支

參數
`branch`	`String`：分支版本名稱

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

設定建構變種版本。

setBuildId

public abstract void setBuildId (String buildId)

設定測試中版本的專屬 ID。不得為空值。

參數
`buildId`	`String`

setDeviceSerial

public abstract void setDeviceSerial (String serial)

設定與此版本相關聯的 ITestDevice 序號。

參數
`serial`	`String`：執行此版本時使用的 `ITestDevice` 序號。

setFile

public abstract void setFile (String name, 
                File file, 
                String version)

在這個版本資訊中儲存指定名稱的檔案。

參數
`name`	`String`：檔案的專屬名稱
`file`	`File`：當地 `ERROR(/File)`
`version`	`String`：檔案版本

setFile

public void setFile (BuildInfoKey.BuildInfoFileKey key, 
                File file, 
                String version)

在這個版本資訊中，儲存 BuildInfoFileKey 指定的檔案。

參數
`key`	`BuildInfoKey.BuildInfoFileKey`：根據 `BuildInfoFileKey` 建立的檔案專屬名稱。
`file`	`File`：當地 `ERROR(/File)`
`version`	`String`：檔案版本

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

為 IBuildInfo 例項設定 BuildInfoProperties。覆寫先前設定的任何現有屬性。

參數
`properties`	`BuildInfoProperties`：要新增的屬性清單。

setTestTag

public abstract void setTestTag (String testTag)

為執行的測試設定不重複的名稱。

參數
`testTag`	`String`

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

在建構資訊的根目錄中，將遠端檔案的一部分檔案設為階段檔案。

TODO(b/138416078)：如果測試所需的模組可以正確建構至測試模組的資料夾，請移除此介面及其呼叫端。

參數
`fileName`	`String`：要位於遠端檔案中的檔案名稱。
`workingDir`	`File`：要將檔案置入暫存區的目錄的 `ERROR(/File)` 物件。

傳回
`File`	在本機 workingDir 中暫存的檔案的 `ERROR(/File)` 物件。

toProto

public BuildInformation.BuildInfo toProto ()

將 BuildInfo 例項序列化為 protobuf。

傳回
`BuildInformation.BuildInfo`