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

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

CommandOptions

public class CommandOptions
extends Object implements ICommandOptions

java.lang.Object
↳	com.android.tradefed.command.CommandOptions

實作 ICommandOptions。

摘要

欄位
`public static final String`	`DRY_RUN_OPTION`
`public static final String`	`ENABLE_SANDBOX_TEST_MODE`
`public static final String`	`INVOCATION_DATA`
`public static final String`	`NOISY_DRY_RUN_OPTION`
`public static final String`	`TEST_TAG_OPTION`
`public static final String`	`USE_REMOTE_SANDBOX`
`public static final String`	`USE_SANDBOX`

公用建構函式
`CommandOptions()`

公用方法
`boolean`	`captureLogcatOnFailure()` 是否要在測試案例失敗時擷取 Logcat
`boolean`	`captureScreenshotOnFailure()` 是否要在測試案例失敗時擷取螢幕截圖
`ICommandOptions`	`clone()`
`boolean`	`earlyDeviceRelease()` 是否在使用完裝置後提早釋放裝置。
`boolean`	`filterPreviousPassedTests()` 是否要篩除先前嘗試中通過的測試案例。
	`getAutoLogCollectors()` 傳回要為叫用項新增的自動記錄收集器集合
	`getDynamicDownloadArgs()` 傳回要傳遞至動態下載查詢的引數對應項目。
`int`	`getExtraRemotePostsubmitInstance()` 在提交後，是否要在遠端 VM 中啟動額外的執行個體。
`String`	`getHostLogSuffix()` 傳回要附加至 Tradefed host_log 的後置字串，如果沒有前置字串，則傳回空值。
`UniqueMultiMap<String, String>`	`getInvocationData()` 傳回傳遞至叫用作業的資料，以便描述該作業
`long`	`getInvocationTimeout()` 傳回指定的叫用逾時。
`long`	`getLoopTime()` 取得重新排定此指令前應等待的時間。
`long`	`getMaxLoopCount()` 傳回排定指令的最大次數。
`boolean`	`getOptimizeMainlineTest()` 如果我們應針對主線程測試最佳化測試模組清單，則傳回 true。
`Duration`	`getParallelSetupTimeout()` 傳回在並行設定期間要使用的逾時值。
`Integer`	`getShardCount()` 傳回指令的總分片數。
`Integer`	`getShardIndex()` 傳回指令的分片索引。
`String`	`getTestTag()` 傳回叫用作業的測試標記。
`String`	`getTestTagSuffix()` 傳回測試標記後置字串，並附加至測試標記，用於表示某項測試的某些變化版本。
`boolean`	`isDryRunMode()` 如果我們應略過將此指令加入佇列，請傳回 `true`。
`boolean`	`isFullHelpMode()` 如果已要求完整的詳細說明模式，則會傳回 `true`
`boolean`	`isHelpMode()` 如果已要求簡短說明模式，則會傳回 `true`
`boolean`	`isLoopMode()` 傳回設定的迴圈模式。
`boolean`	`isNoisyDryRunMode()` 如果我們應先將指令列印到主控台，再略過將其新增至佇列，請傳回 `true`。
`boolean`	`reportInvocationComplete()` 是否在呼叫完成前回報記錄。
`boolean`	`reportPassedTests()` 是否要回報已通過的測試案例。
`boolean`	`reportTestCaseCount()` 是否要回報每個測試類型的測試案例數量。
	`reportingTags()` 用於回報與叫用相關資訊的標記清單。
`boolean`	`runOnAllDevices()` 如果指令應在所有裝置上執行，則傳回 true。
`void`	`setAutoLogCollectors( autoLogCollectors)` 設定應新增至叫用作業的自動記錄收集器集。
`void`	`setBugreportOnInvocationEnded(boolean takeBugreport)` 設定是否要在叫用作業結束時擷取錯誤報告。
`void`	`setBugreportzOnInvocationEnded(boolean takeBugreportz)` 設定是否要在叫用結束時擷取 bugreportz。
`void`	`setHostLogSuffix(String suffix)` 設定要附加至 Tradefed host_log 的後置字串。
`void`	`setInvocationTimeout(Long invocationTimeout)` 設定叫用逾時。
`void`	`setLoopMode(boolean loopMode)` 設定循環模式。
`void`	`setReplicateSetup(boolean replicate)` 設定是否要使用複製設定。
`void`	`setReportInvocationComplete(boolean reportInvocationCompleteLogs)` 設定是否要等到 invocationComplete 才回報記錄
`void`	`setReportTestCaseCount(boolean report)` 設定是否要回報每個測試類型的測試案例數量。
`void`	`setShardCount(Integer shardCount)` 設定指令的分割區數量。
`void`	`setShardIndex(Integer shardIndex)` 設定指令的分割區索引。
`void`	`setShouldUseSandboxing(boolean use)` 設定是否應使用 TF 容器
`void`	`setTestTag(String testTag)` 設定叫用作業的測試標記。
`void`	`setUseSandboxTestMode(boolean use)` 設定是否應使用 TF 沙箱測試模式。
`boolean`	`shouldDisableInvocationSetupAndTeardown()` 是否要停用呼叫前設定和呼叫後拆除作業。
`boolean`	`shouldReportModuleProgression()` 是否要在模組層級回報遠端叫用作業的進度。
`boolean`	`shouldUseDynamicSharding()` 傳回是否應使用動態分割
`boolean`	`shouldUseParallelRemoteSetup()` 是否嘗試並行設定遠端裝置。
`boolean`	`shouldUseParallelSetup()` 是否嘗試並行設定。
`boolean`	`shouldUseRemoteSandboxMode()` 是否在遠端叫用中使用沙箱模式。
`boolean`	`shouldUseReplicateSetup()` 是否要為所有遠端裝置使用複製設定。
`boolean`	`shouldUseSandboxTestMode()` 如果應在測試模式下使用 Tf 沙箱，則傳回 true。
`boolean`	`shouldUseSandboxing()` 如果我們應使用 Tf 容器執行叫用作業，則傳回「是」
`boolean`	`shouldUseTokenSharding()` 是否應使用符記支援功能進行分割。
`boolean`	`takeBugreportOnInvocationEnded()` 如果應在測試叫用作業結束時擷取錯誤報告，則傳回 true。
`boolean`	`takeBugreportzOnInvocationEnded()` 如果在測試叫用期間應取用 bugreportz 而非 bugreport，則傳回 true。

欄位

DRY_RUN_OPTION

public static final String DRY_RUN_OPTION

ENABLE_SANDBOX_TEST_MODE

public static final String ENABLE_SANDBOX_TEST_MODE

INVOCATION_DATA

public static final String INVOCATION_DATA

NOISY_DRY_RUN_OPTION

public static final String NOISY_DRY_RUN_OPTION

TEST_TAG_OPTION

public static final String TEST_TAG_OPTION

USE_REMOTE_SANDBOX

public static final String USE_REMOTE_SANDBOX

USE_SANDBOX

public static final String USE_SANDBOX

公用建構函式

CommandOptions

public CommandOptions ()

公用方法

captureLogcatOnFailure

public boolean captureLogcatOnFailure ()

是否要在測試案例失敗時擷取 Logcat

傳回
`boolean`

captureScreenshotOnFailure

public boolean captureScreenshotOnFailure ()

是否要在測試案例失敗時擷取螢幕截圖

傳回
`boolean`

clone

public ICommandOptions clone ()

傳回
`ICommandOptions`

earlyDeviceRelease

public boolean earlyDeviceRelease ()

是否在使用完畢後提早釋放裝置。

傳回
`boolean`

filterPreviousPassedTests

public boolean filterPreviousPassedTests ()

是否要篩除先前嘗試中已通過的測試案例。

傳回
`boolean`

getAutoLogCollectors

public  getAutoLogCollectors ()

傳回要為叫用項新增的自動記錄收集器集

傳回

getDynamicDownloadArgs

public  getDynamicDownloadArgs ()

傳回要傳遞至動態下載查詢的引數對應項目。

傳回

getExtraRemotePostsubmitInstance

public int getExtraRemotePostsubmitInstance ()

在提交後，是否要在遠端 VM 中啟動額外的執行個體。

傳回
`int`

getHostLogSuffix

public String getHostLogSuffix ()

傳回要附加至 Tradefed host_log 的字尾，如果沒有前置字串，則傳回空值。

傳回
`String`

getInvocationData

public UniqueMultiMap<String, String> getInvocationData ()

傳回傳遞至叫用作業的資料，以便描述該作業

傳回
`UniqueMultiMap<String, String>`

getInvocationTimeout

public long getInvocationTimeout ()

傳回指定的叫用逾時。如果沒有要使用的逾時值，則為 0。

傳回
`long`

getLoopTime

public long getLoopTime ()

取得重新排定此指令前應等待的時間。

傳回
`long`	時間 (以毫秒為單位)

getMaxLoopCount

public long getMaxLoopCount ()

傳回排定指令的最大次數。如果 isLoopMode 為 False，這個值就不會生效。

傳回
`long`

getOptimizeMainlineTest

public boolean getOptimizeMainlineTest ()

如果我們應針對主線測試最佳化測試模組清單，則會傳回 true。

傳回
`boolean`

getParallelSetupTimeout

public Duration getParallelSetupTimeout ()

傳回在並行設定期間要使用的逾時值。

傳回
`Duration`

getShardCount

public Integer getShardCount ()

傳回指令的總分片數。

傳回
`Integer`

getShardIndex

public Integer getShardIndex ()

傳回指令的分割區索引。

傳回
`Integer`

getTestTag

public String getTestTag ()

傳回叫用作業的測試標記。如未指定，預設值為「stub」。

傳回
`String`

getTestTagSuffix

public String getTestTagSuffix ()

傳回測試標記後置字串，附加至測試標記，用於代表某項測試的某些變化版本。

傳回
`String`

isDryRunMode

public boolean isDryRunMode ()

如果我們應略過將此指令加入佇列，請傳回 true。

傳回
`boolean`

isFullHelpMode

public boolean isFullHelpMode ()

如果使用者要求完整的詳細說明模式，系統會傳回 true

傳回
`boolean`

isHelpMode

public boolean isHelpMode ()

如果已要求簡短說明模式，則會傳回 true

傳回
`boolean`

isLoopMode

public boolean isLoopMode ()

傳回設定的迴圈模式。

傳回
`boolean`

isNoisyDryRunMode

public boolean isNoisyDryRunMode ()

如果我們應先將指令列印到主控台，再略過將其新增至佇列，請傳回 true。

傳回
`boolean`

reportInvocationComplete

public boolean reportInvocationComplete ()

是否在呼叫完成前回報記錄。

傳回
`boolean`

reportPassedTests

public boolean reportPassedTests ()

是否要回報已通過的測試案例。

傳回
`boolean`

reportTestCaseCount

public boolean reportTestCaseCount ()

是否要回報每個測試類型的測試案例數量。

傳回
`boolean`

reportingTags

public  reportingTags ()

用於回報與叫用相關資訊的標記清單。

傳回

runOnAllDevices

public boolean runOnAllDevices ()

如果指令應在所有裝置上執行，則傳回 true。

傳回
`boolean`

setAutoLogCollectors

public void setAutoLogCollectors ( autoLogCollectors)

設定應新增至叫用作業的自動記錄收集器集。

參數
`autoLogCollectors`

setBugreportOnInvocationEnded

public void setBugreportOnInvocationEnded (boolean takeBugreport)

設定是否要在叫用作業結束時擷取錯誤報告。

參數
`takeBugreport`	`boolean`

setBugreportzOnInvocationEnded

public void setBugreportzOnInvocationEnded (boolean takeBugreportz)

設定是否要在呼叫結束時擷取 bugreportz。

參數
`takeBugreportz`	`boolean`

setHostLogSuffix

public void setHostLogSuffix (String suffix)

設定要附加至 Tradefed host_log 的字尾。

參數
`suffix`	`String`

setInvocationTimeout

public void setInvocationTimeout (Long invocationTimeout)

設定叫用逾時時間。如果沒有要使用的逾時值，則為 0。

參數
`invocationTimeout`	`Long`

setLoopMode

public void setLoopMode (boolean loopMode)

設定循環模式。

setReplicateSetup

public void setReplicateSetup (boolean replicate)

設定是否要使用複製設定。

參數
`replicate`	`boolean`

setReportInvocationComplete

public void setReportInvocationComplete (boolean reportInvocationCompleteLogs)

設定是否要等到 invocationComplete 後才回報記錄

參數
`reportInvocationCompleteLogs`	`boolean`

setReportTestCaseCount

public void setReportTestCaseCount (boolean report)

設定是否要回報每個測試類型的測試案例數量。

參數
`report`	`boolean`

setShardCount

public void setShardCount (Integer shardCount)

設定指令的分割區數量。

參數
`shardCount`	`Integer`

setShardIndex

public void setShardIndex (Integer shardIndex)

設定指令的分割區索引。

參數
`shardIndex`	`Integer`

setShouldUseSandboxing

public void setShouldUseSandboxing (boolean use)

設定是否應使用 TF 容器

參數
`use`	`boolean`

setTestTag

public void setTestTag (String testTag)

設定叫用作業的測試標記。

setUseSandboxTestMode

public void setUseSandboxTestMode (boolean use)

設定是否應使用 TF 沙箱測試模式。

參數
`use`	`boolean`

shouldDisableInvocationSetupAndTeardown

public boolean shouldDisableInvocationSetupAndTeardown ()

是否要停用呼叫前設定和呼叫後拆除作業。

傳回
`boolean`

shouldReportModuleProgression

public boolean shouldReportModuleProgression ()

是否要在模組層級回報遠端叫用作業的進度。

傳回
`boolean`

shouldUseDynamicSharding

public boolean shouldUseDynamicSharding ()

傳回是否應使用動態分割

傳回
`boolean`

shouldUseParallelRemoteSetup

public boolean shouldUseParallelRemoteSetup ()

是否嘗試為遠端裝置進行平行設定。

傳回
`boolean`

shouldUseParallelSetup

public boolean shouldUseParallelSetup ()

是否嘗試並行設定。

傳回
`boolean`

shouldUseRemoteSandboxMode

public boolean shouldUseRemoteSandboxMode ()

在遠端叫用作業中是否要使用沙箱模式。

傳回
`boolean`

shouldUseReplicateSetup

public boolean shouldUseReplicateSetup ()

是否要為所有遠端裝置使用複製設定。

傳回
`boolean`

shouldUseSandboxTestMode

public boolean shouldUseSandboxTestMode ()

如果我們應在測試模式中使用 Tf 沙箱，則傳回 true。

傳回
`boolean`

shouldUseSandboxing

public boolean shouldUseSandboxing ()

如果應使用 Tf 容器執行叫用作業，則傳回 true

傳回
`boolean`

shouldUseTokenSharding

public boolean shouldUseTokenSharding ()

是否應使用符記支援功能進行分割。

傳回
`boolean`

takeBugreportOnInvocationEnded

public boolean takeBugreportOnInvocationEnded ()

如果在測試叫用作業結束時應擷取錯誤報告，則傳回 true。

傳回
`boolean`

takeBugreportzOnInvocationEnded

public boolean takeBugreportzOnInvocationEnded ()

如果在測試叫用期間應取用 bugreportz 而非 bugreport，則傳回 true。

傳回
`boolean`