ICommandOptions

public interface ICommandOptions

com.android.tradefed.command.ICommandOptions

已知的间接子类 CommandOptions CommandOptions ICommandOptions 的实现。

---

用于命令执行选项的容器。

摘要

公共方法
abstract boolean	captureLogcatOnFailure() 是否在测试用例失败时捕获 logcat
abstract boolean	captureScreenshotOnFailure() 是否在测试用例失败时截取屏幕截图
abstract ICommandOptions	clone() 创建 ICommandOptions 对象的副本。
abstract boolean	delegatedEarlyDeviceRelease() 是否在委托模式下提前释放设备。
abstract boolean	earlyDeviceRelease() 是否在使用完毕后提前发布设备。
abstract boolean	filterPreviousPassedTests() 是否过滤上次尝试中已通过的测试用例。
abstract	getAutoLogCollectors() 返回要为调用添加的一组自动日志收集器
abstract	getDynamicDownloadArgs() 返回要传递给动态下载查询的参数映射。
abstract	getExperimentalFlags() 返回实验性标志映射，可用于功能门控项目。
abstract int	getExtraRemotePostsubmitInstance() 是否在提交后启动远程虚拟机中的额外实例。
abstract String	getHostLogSuffix() 返回要附加到 Tradefed host_log 的后缀；如果没有前缀，则返回 null。
abstract UniqueMultiMap<String, String>	getInvocationData() 返回传递给调用的描述数据
abstract long	getInvocationTimeout() 返回指定的调用超时时间。
abstract File	getJdkFolderForSubprocess() 返回在子进程中分叉执行时要使用的 JDK 文件夹。
abstract long	getLoopTime() 获取重新调度此命令之前需要等待的时间。
abstract long	getMaxLoopCount() 返回调度命令的最大次数。
abstract Integer	getMultiDeviceCount() 返回多设备测试的设备数量。
abstract boolean	getOptimizeMainlineTest() 如果我们应为 Mainline 测试优化测试模块列表，会返回 true。
abstract Duration	getParallelPreInvocationSetupTimeout() 返回并行预调用设置的超时时间。
abstract Duration	getParallelSetupTimeout() 返回要在并行设置期间使用的超时时间。
abstract String	getRemoteCacheInstanceName() 返回用于处理远程缓存的实例的名称。
abstract	getRemoteFiles() 返回已配置的远程文件列表。
abstract Integer	getShardCount() 返回命令的分片总数。
abstract Integer	getShardIndex() 返回命令的分片索引。
abstract String	getTestTag() 返回调用的测试标记。
abstract String	getTestTagSuffix() 返回要附加到 test-tag 以表示某个测试的某些变体的 test-tag 后缀。
abstract boolean	isConditionalBugreportDisabled() 返回是否停用了有条件的 bug 报告
abstract boolean	isDryRunMode() 如果应跳过将此命令添加到队列，则返回 true。
abstract boolean	isExperimentEnabled() 是否通过实验性标志启用实验。
abstract boolean	isFullHelpMode() 如果已请求完整详细帮助模式，则返回 true
abstract boolean	isHelpMode() 如果已请求缩写帮助模式，则返回 true
abstract boolean	isLoopMode() 返回配置的循环模式。
abstract boolean	isNoisyDryRunMode() 如果应先将命令输出到控制台，然后再跳过将其添加到队列，请返回 true。
abstract boolean	isRemoteInvocationDeviceless() 是否触发无设备远程调用。
abstract boolean	isTracingEnabled() 返回是否已启用调用跟踪。
abstract boolean	reportCacheResults() 如果应在有缓存结果时报告缓存结果，则返回 true。
abstract boolean	reportInvocationComplete() 是否在 invocationComplete 之前报告日志。
abstract boolean	reportPassedTests() 是否报告已通过的测试用例。
abstract boolean	reportTestCaseCount() 是否报告每种测试类型的测试用例数量。
abstract	reportingTags() 用于报告与调用相关信息的标签列表。
abstract boolean	runOnAllDevices() 如果命令应在所有设备上运行，则返回 true。
abstract void	setAutoLogCollectors( autoLogCollectors) 设置应添加到调用的一组自动日志收集器。
abstract void	setBugreportOnInvocationEnded(boolean takeBugreport) 设置是否在调用结束时捕获 bug 报告。
abstract void	setBugreportzOnInvocationEnded(boolean takeBugreportz) 设置是否在调用结束时捕获 bugreportz。
abstract void	setDelegatedEarlyDeviceRelease(boolean earlyRelease) 设置是否在委托模式下提前释放设备。
abstract void	setHostLogSuffix(String suffix) 设置要附加到 Tradefed host_log 的后缀。
abstract void	setInvocationTimeout(Long mInvocationTimeout) 设置调用超时。
abstract void	setLoopMode(boolean loopMode) 为命令设置循环模式
abstract void	setMultiDeviceCount(int count) 为多设备测试设置预期设备数量。
abstract void	setReplicateSetup(boolean replicate) 设置是否使用复制设置。
abstract void	setReportInvocationComplete(boolean reportInvocationCompleteLogs) 设置是否在 invocationComplete 之前报告日志
abstract void	setReportTestCaseCount(boolean report) 设置是否报告每个测试类型的测试用例数量。
abstract void	setShardCount(Integer shardCount) 设置命令的分片数量。
abstract void	setShardIndex(Integer shardIndex) 设置命令的分片编号。
abstract void	setShouldRemoteDynamicShard(boolean shouldRemoteDynamicShard) 设置是否使用远程动态分片服务器
abstract void	setShouldUseEvenModuleSharding(boolean useEvenModuleSharding) 设置是否尝试在分片中均匀分布模块数量
abstract void	setShouldUseSandboxing(boolean use) 设置是否应使用 TF 容器
abstract void	setTestTag(String testTag) 为调用设置测试标记。
abstract void	setUseSandboxTestMode(boolean use) 设置是否应使用 TF 沙盒测试模式。
abstract boolean	shouldDisableInvocationSetupAndTeardown() 是否停用调用前设置和调用后拆解。
abstract boolean	shouldRemoteDynamicShard() 返回是否使用远程动态分片服务器
abstract boolean	shouldReportModuleProgression() 是否在模块级报告远程调用的进度。
abstract boolean	shouldUploadCacheResults() 如果应在缓存中捕获结果，则返回 true。
abstract boolean	shouldUseDynamicSharding() 返回是否应使用动态分片
abstract boolean	shouldUseEvenModuleSharding() 返回是否尝试在分片中均匀分布模块数量
abstract boolean	shouldUseParallelPreInvocationSetup() 返回是否并行执行调用前设置。
abstract boolean	shouldUseParallelRemoteSetup() 是否尝试并行设置远程设备。
abstract boolean	shouldUseParallelSetup() 是否尝试并行设置。
abstract boolean	shouldUseRemoteSandboxMode() 是否在远程调用中使用沙盒模式。
abstract boolean	shouldUseReplicateSetup() 是否为所有远程设备使用复制设置。
abstract boolean	shouldUseSandboxTestMode() 如果我们应在测试模式下使用 Tf 沙盒，则返回 true。
abstract boolean	shouldUseSandboxing() 如果我们应使用 Tf 容器运行调用，则返回 true
abstract boolean	shouldUseTokenSharding() 分片是否应使用令牌支持。
abstract boolean	skipTrybotExperiment() 是否为 TRYBOT 运行跳过实验。
abstract boolean	takeBugreportOnInvocationEnded() 如果应在测试调用结束时获取 bug 报告，则返回 true。
abstract boolean	takeBugreportzOnInvocationEnded() 如果在测试调用最终 bugreport 期间应使用 bugreportz 而非 bugreport，则返回 true。

公共方法

captureLogcatOnFailure

public abstract boolean captureLogcatOnFailure ()

是否在测试用例失败时捕获 logcat

返回
boolean

CaptureScreenshotOnFailure

public abstract boolean captureScreenshotOnFailure ()

是否在测试用例失败时截取屏幕截图

返回
boolean

克隆

public abstract ICommandOptions clone ()

创建 ICommandOptions 对象的副本。

返回
ICommandOptions

DelegatedEarlyDeviceRelease

public abstract boolean delegatedEarlyDeviceRelease ()

是否在委托模式下提前释放设备。

返回
boolean

earlyDeviceRelease

public abstract boolean earlyDeviceRelease ()

使用完设备后是否提前将其释放。

返回
boolean

filterPreviousPassedTests

public abstract boolean filterPreviousPassedTests ()

是否从上一次尝试中过滤之前通过的测试用例。

返回
boolean

getAutoLogCollectors

public abstract  getAutoLogCollectors ()

返回要为调用添加的一组自动日志收集器

返回

getDynamicDownloadArgs

public abstract  getDynamicDownloadArgs ()

返回要传递给动态下载查询的参数映射。

返回

getExperimentalFlags

public abstract  getExperimentalFlags ()

返回实验性标志映射，可用于功能门控项目。

返回

getExtraRemotePostsubmitInstance

public abstract int getExtraRemotePostsubmitInstance ()

在提交后，是否在远程虚拟机中启动额外实例。

返回
int

getHostLogSuffix

public abstract String getHostLogSuffix ()

返回要附加到 Tradefed host_log 的后缀，如果没有前缀，则返回 null。

返回
String

getInvocationData

public abstract UniqueMultiMap<String, String> getInvocationData ()

返回传递给调用来描述它的数据

返回
UniqueMultiMap<String, String>

getInvocationTimeout

public abstract long getInvocationTimeout ()

返回指定的调用超时时间。如果不使用超时，则为 0。

返回
long

getJdkFolderForSubprocess

public abstract File getJdkFolderForSubprocess ()

返回在子进程中分叉执行时要使用的 JDK 文件夹。

返回
File

getLoopTime

public abstract long getLoopTime ()

获取重新调度此命令之前需要等待的时间。

返回
long	时间（毫秒）

getMaxLoopCount

public abstract long getMaxLoopCount ()

返回安排命令的次数上限。如果 isLoopMode 为 false，则没有任何影响。

返回
long

getMultiDeviceCount

public abstract Integer getMultiDeviceCount ()

返回多设备测试的设备数量。

返回
Integer

getOptimizeMainlineTest

public abstract boolean getOptimizeMainlineTest ()

如果我们应优化 Mainline 测试的测试模块列表，则返回 true。

返回
boolean

getParallelPreInvocationSetupTimeout

public abstract Duration getParallelPreInvocationSetupTimeout ()

返回并行预调用设置的超时时间。

返回
Duration

getParallelSetupTimeout

public abstract Duration getParallelSetupTimeout ()

返回要在并行设置期间使用的超时时间。

返回
Duration

getRemoteCacheInstanceName

public abstract String getRemoteCacheInstanceName ()

返回用于处理远程缓存的实例的名称。

返回
String

getRemoteFiles

public abstract  getRemoteFiles ()

返回已配置的远程文件列表。

返回

getShardCount

public abstract Integer getShardCount ()

返回该命令的总分片数。

返回
Integer

getShardIndex

public abstract Integer getShardIndex ()

返回命令的分片索引。

返回
Integer

getTestTag

public abstract String getTestTag ()

返回调用的测试标记。如果未指定，则默认为“stub”。

返回
String

getTestTagSuffix

public abstract String getTestTagSuffix ()

返回附加到 test-tag 的 test-tag 后缀，用于表示某个测试的某些变体。

返回
String

isConditionalBugreportDisabled

public abstract boolean isConditionalBugreportDisabled ()

返回是否停用了有条件的 bug 报告

返回
boolean

isDryRunMode

public abstract boolean isDryRunMode ()

如果应跳过将此命令添加到队列，则返回 true。

返回
boolean

isExperimentEnabled

public abstract boolean isExperimentEnabled ()

是否通过实验性标志启用实验。

返回
boolean

isFullHelpMode

public abstract boolean isFullHelpMode ()

如果已请求完整详细帮助模式，则返回 true

返回
boolean

isHelpMode

public abstract boolean isHelpMode ()

如果已请求缩写帮助模式，则返回 true

返回
boolean

isLoopMode

public abstract boolean isLoopMode ()

返回配置的循环模式。

返回
boolean

isNoisyDryRunMode

public abstract boolean isNoisyDryRunMode ()

如果应先将命令输出到控制台，然后再跳过将其添加到队列，请返回 true。

返回
boolean

isRemoteInvocationDeviceless

public abstract boolean isRemoteInvocationDeviceless ()

是否触发无设备远程调用。

返回
boolean

isTracingEnabled

public abstract boolean isTracingEnabled ()

返回是否启用了调用跟踪。

返回
boolean

reportCacheResults 类中的方法

public abstract boolean reportCacheResults ()

如果应在有缓存结果时报告缓存结果，则返回 true。

返回
boolean

reportInvocationComplete

public abstract boolean reportInvocationComplete ()

是否在 invocationComplete 之前报告日志。

返回
boolean

reportPassedTests

public abstract boolean reportPassedTests ()

是否报告已通过的测试用例。

返回
boolean

reportTestCaseCount

public abstract boolean reportTestCaseCount ()

是否报告每个测试类型的测试用例数量。

返回
boolean

reportingTag

public abstract  reportingTags ()

用于生成与调用相关的报告的标记列表。

返回

runOnAllDevices

public abstract boolean runOnAllDevices ()

如果命令应在所有设备上运行，则返回 true。

返回
boolean

setAutoLogCollectors

public abstract void setAutoLogCollectors ( autoLogCollectors)

设置应添加到调用的一组自动日志收集器。

参数
autoLogCollectors

setBugreportOnInvocationEnded

public abstract void setBugreportOnInvocationEnded (boolean takeBugreport)

设置是否在调用结束时捕获 bug 报告。

参数
takeBugreport	boolean

setBugreportzOnInvocationEnded

public abstract void setBugreportzOnInvocationEnded (boolean takeBugreportz)

设置是否在调用结束时捕获 bugreportz。

参数
takeBugreportz	boolean

setDelegatedEarlyDeviceRelease

public abstract void setDelegatedEarlyDeviceRelease (boolean earlyRelease)

设置是否要在委托模式下提前释放设备。

参数
earlyRelease	boolean

setHostLogSuffix

public abstract void setHostLogSuffix (String suffix)

设置要附加到 Tradefed host_log 的后缀。

参数
suffix	String

setInvocationTimeout

public abstract void setInvocationTimeout (Long mInvocationTimeout)

设置调用超时。如果不使用超时，则为 0。

参数
mInvocationTimeout	Long

setLoopMode

public abstract void setLoopMode (boolean loopMode)

为命令设置循环模式

setMultiDeviceCount

public abstract void setMultiDeviceCount (int count)

设置多设备测试的预期设备数量。

参数
count	int

setReplicateSetup

public abstract void setReplicateSetup (boolean replicate)

设置是否使用复制设置。

参数
replicate	boolean

setReportInvocationComplete

public abstract void setReportInvocationComplete (boolean reportInvocationCompleteLogs)

设置是否在 invocationComplete 之前报告日志

参数
reportInvocationCompleteLogs	boolean

setReportTestCaseCount

public abstract void setReportTestCaseCount (boolean report)

设置是否报告每种测试类型的测试用例数。

参数
report	boolean

setShardCount

public abstract void setShardCount (Integer shardCount)

设置命令的分片数。

参数
shardCount	Integer

setShardIndex

public abstract void setShardIndex (Integer shardIndex)

设置命令的分片编号。

参数
shardIndex	Integer

setShouldRemoteDynamicShard

public abstract void setShouldRemoteDynamicShard (boolean shouldRemoteDynamicShard)

设置是否使用远程动态分片服务器

参数
shouldRemoteDynamicShard	boolean

setShouldUseEvenModuleSharding

public abstract void setShouldUseEvenModuleSharding (boolean useEvenModuleSharding)

设置是否尝试在分片中均匀分布模块数量

参数
useEvenModuleSharding	boolean

setShouldUseSandboxing

public abstract void setShouldUseSandboxing (boolean use)

设置我们是否应使用 TF 容器

参数
use	boolean

setTestTag

public abstract void setTestTag (String testTag)

为调用设置测试标记。

setUseSandboxTestMode

public abstract void setUseSandboxTestMode (boolean use)

设置是否应使用 TF 沙盒测试模式。

参数
use	boolean

shouldDisableInvocationSetupAndTeardown

public abstract boolean shouldDisableInvocationSetupAndTeardown ()

是否停用调用前设置和调用后拆解。

返回
boolean

shouldRemoteDynamicShard

public abstract boolean shouldRemoteDynamicShard ()

返回是否使用远程动态分片服务器

返回
boolean

shouldReportModuleProgression

public abstract boolean shouldReportModuleProgression ()

是否在模块级报告远程调用的进度。

返回
boolean

shouldUploadCacheResults

public abstract boolean shouldUploadCacheResults ()

如果我们应该在缓存中捕获结果，则返回 true。

返回
boolean

shouldUseDynamicSharding

public abstract boolean shouldUseDynamicSharding ()

返回是否应使用动态分片

返回
boolean

shouldUseEvenModuleSharding

public abstract boolean shouldUseEvenModuleSharding ()

返回是否尝试在分片中均匀分布模块数量

返回
boolean

shouldUseParallelPreInvocationSetup

public abstract boolean shouldUseParallelPreInvocationSetup ()

返回是否并行执行调用前设置。

返回
boolean

shouldUseParallelRemoteSetup

public abstract boolean shouldUseParallelRemoteSetup ()

是否尝试并行设置远程设备。

返回
boolean

shouldUseParallelSetup

public abstract boolean shouldUseParallelSetup ()

是否尝试并行设置。

返回
boolean

shouldUseRemoteSandboxMode

public abstract boolean shouldUseRemoteSandboxMode ()

是否在远程调用中使用沙盒模式。

返回
boolean

shouldUseReplicateSetup

public abstract boolean shouldUseReplicateSetup ()

是否为所有远程设备使用复制设置。

返回
boolean

shouldUseSandboxTestMode

public abstract boolean shouldUseSandboxTestMode ()

如果应在测试模式下使用 Tf 沙盒，则返回 true。

返回
boolean

应当使用沙盒

public abstract boolean shouldUseSandboxing ()

如果应使用 Tf 容器运行调用，则返回 true

返回
boolean

shouldUseTokenSharding

public abstract boolean shouldUseTokenSharding ()

分片是否应使用令牌支持。

返回
boolean

skipTrybotExperiment

public abstract boolean skipTrybotExperiment ()

是否为 TRYBOT 运行跳过实验。

返回
boolean

takeBugreportOnInvocationEnded

public abstract boolean takeBugreportOnInvocationEnded ()

如果应在测试调用结束时获取 bug 报告，则返回 true。

返回
boolean

takeBugreportzOnInvocationEnded

public abstract boolean takeBugreportzOnInvocationEnded ()

如果在测试调用最终 bugreport 期间应使用 bugreportz 而非 bugreport，则返回 true。

返回
boolean