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

IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

已知間接子類別

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

AppBuildInfo	代表 Android 應用程式及其測試套件的 `IBuildInfo`。
AppDeviceBuildInfo	這個類別已淘汰，請直接使用 `IDeviceBuildInfo`。
建構資訊	應建立關聯的 `IBuildInfo` 一般實作搭配 `ITestDevice`。
ClusterBuildInfo	透過 TFC 管道管道適用的 `IBuildInfo` 類別。
DeviceBuildInfo	`IBuildInfo` 代表完整的 Android 裝置版本及其測試 (選用)。
DeviceFolderBuildInfo	`IDeviceBuildInfo`，包含本機檔案系統
FolderBuildInfo	`IFolderBuildInfo` 的具體實作。
IAppBuildInfo	這個介面已淘汰，請直接使用 `IBuildInfo`。
IDeviceBuildInfo	`IBuildInfo` 代表完整的 Android 裝置版本及其測試 (選用)。
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)` 移除追蹤中的指定屬性名稱。
`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 檔案及其相關版本。請注意，APK 將由下列來源傳回 getAppPackageFiles()，依照此方法新增的順序。

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

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

新增建構屬性。但這無法覆寫現有的屬性名稱。

參數
`attributeName`	`String`：專屬屬性名稱
`attributeValue`	`String`：屬性值

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

新增建構屬性

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

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

設定權限，允許執行測試環境遠端檔案。

參數
`stageRemoteFile`	`boolean`

清理

public abstract void cleanUp ()

清除任何暫存建構檔案

清理

public abstract void cleanUp ( doNotDelete)

cleanUp() 版本，其中某些檔案未刪除。

參數
`doNotDelete`

本機副本

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 平台版本的常見實作方式是 (build product)-(build os)-(建構變數)。 ie generic-linux-userdebug

傳回
`String`	建構變種版本；如果未設定/不適用，則為 `null`

getBuildId

public abstract String getBuildId ()

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

傳回
`String`

getBuildTargetName

public abstract String getBuildTargetName ()

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

常見的實作方式是使用以下項目建構建構目標名稱：建構版本和分支版本名稱[ie (branch name)-(build flavor)]

傳回
`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`	`String`：停止追蹤的屬性

setBuild 分支版本

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` 序號。

設定檔案

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

將具有指定名稱的檔案儲存在這項建構資訊中。

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

設定檔案

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`	暫存於本機 taskDir 中的檔案 `ERROR(/File)` 物件。

通訊協定

public BuildInformation.BuildInfo toProto ()

將 BuildInfo 例項序列化到 protobuf。

傳回
`BuildInformation.BuildInfo`