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

指令選項

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()` 傳回要傳遞給動態下載查詢的 args 對應。
`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` skip 新增至佇列。
`boolean`	`reportInvocationComplete()` 是否在叫用完成之前回報記錄。
`boolean`	`reportPassedTests()` 是否回報通過的測試案例。
`boolean`	`reportTestCaseCount()` 是否回報各測試類型的測試案例數量。
	`reportingTags()` 用於回報與叫用相關的標記清單。
`boolean`	`runOnAllDevices()` 如果指令應在所有裝置上執行，則傳回 true。
`void`	`setAutoLogCollectors( autoLogCollectors)` 設定一組要新增至叫用的自動記錄收集器。
`void`	`setBugreportOnInvocationEnded(boolean takeBugreport)` 設定是否要在叫用結束時擷取錯誤報告。
`void`	`setBugreportzOnInvocationEnded(boolean takeBugreportz)` 設定是否要在叫用結束時擷取錯誤報告。
`void`	`setHostLogSuffix(String suffix)` 設定要附加至 Tradefed host_log 的後置字串。
`void`	`setInvocationTimeout(Long invocationTimeout)` 設定叫用逾時。
`void`	`setLoopMode(boolean loopMode)` 設定設定的循環模式。
`void`	`setReplicateSetup(boolean replicate)` 設定是否使用複製設定。
`void`	`setReportInvocationComplete(boolean reportInvocationCompleteLogs)` 設定是否在叫用完成之前回報記錄
`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 容器執行叫用，則傳回 true
`boolean`	`shouldUseTokenSharding()` 資料分割是否應使用權杖支援。
`boolean`	`takeBugreportOnInvocationEnded()` 如果應在測試叫用結束時取得錯誤報告，則傳回 true。
`boolean`	`takeBugreportzOnInvocationEnded()` 如果應在測試叫用期間取得錯誤報告，而非錯誤報告，則傳回 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

使用沙箱

public static final String USE_REMOTE_SANDBOX

使用沙箱

public static final String USE_SANDBOX

公用建構函式

指令選項

public CommandOptions ()

公用方法

擷取 LogcatOnFailure

public boolean captureLogcatOnFailure ()

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

傳回
`boolean`

擷取螢幕截圖螢幕失敗

public boolean captureScreenshotOnFailure ()

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

傳回
`boolean`

本機副本

public ICommandOptions clone ()

傳回
`ICommandOptions`

EarlyDeviceRelease

public boolean earlyDeviceRelease ()

使用完裝置後，是否要提早釋放裝置。

傳回
`boolean`

filterPreviousPassedTests

public boolean filterPreviousPassedTests ()

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

傳回
`boolean`

getAutoLogCollectors

public  getAutoLogCollectors ()

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

傳回

取得 DynamicDownloadArgs

public  getDynamicDownloadArgs ()

傳回要傳遞給動態下載查詢的 args 對應。

傳回

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`

取得最佳化 MainlineTest

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 skip 新增至佇列。

傳回
`boolean`

reportInvocationComplete

public boolean reportInvocationComplete ()

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

傳回
`boolean`

reportPassedTests

public boolean reportPassedTests ()

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

傳回
`boolean`

reportTestCaseCount

public boolean reportTestCaseCount ()

是否回報各測試類型的測試案例數量。

傳回
`boolean`

報表代碼

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)

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

參數
`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)

設定是否在叫用完成之前回報記錄

參數
`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`

setSetUseSandboxing

public void setShouldUseSandboxing (boolean use)

設定是否應使用 TF 容器

參數
`use`	`boolean`

setTestTag

public void setTestTag (String testTag)

設定叫用的測試標記。

設定使用沙箱測試模式

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`

應使用沙箱

public boolean shouldUseSandboxing ()

如果我們應該使用 Tf 容器執行叫用，則傳回 true

傳回
`boolean`

shouldUseTokenSharding

public boolean shouldUseTokenSharding ()

資料分割是否應使用權杖支援。

傳回
`boolean`

TakeBugreportOnInvocationEnded

public boolean takeBugreportOnInvocationEnded ()

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

傳回
`boolean`

TakeBugreportzOnInvocationEnded

public boolean takeBugreportzOnInvocationEnded ()

如果應在測試叫用期間取得錯誤報告，而非錯誤報告，則傳回 true 最終錯誤報告。

傳回
`boolean`