CommandOptions
public
class
CommandOptions
extends Object
implements
ICommandOptions
java.lang.Object | |
↳ | com.android.tradefed.command.CommandOptions |
Implementation of ICommandOptions
.
Summary
Constants | |
---|---|
String |
DRY_RUN_OPTION
|
String |
NOISY_DRY_RUN_OPTION
|
String |
USE_SANDBOX
|
Public constructors | |
---|---|
CommandOptions()
|
Public methods | |
---|---|
ICommandOptions
|
clone()
|
UniqueMultiMap<String, String>
|
getInvocationData()
Returns the data passed to the invocation to describe it |
long
|
getInvocationTimeout()
Return the invocation timeout specified. |
long
|
getLoopTime()
Get the time to wait before re-scheduling this command. |
long
|
getMinLoopTime()
This method is deprecated.
use |
Integer
|
getShardCount()
Return the total shard count for the command. |
Integer
|
getShardIndex()
Return the shard index for the command. |
String
|
getTestTag()
Return the test-tag for the invocation. |
String
|
getTestTagSuffix()
Return the test-tag suffix, appended to test-tag to represents some variants of one test. |
boolean
|
isDryRunMode()
Return |
boolean
|
isFullHelpMode()
Returns |
boolean
|
isHelpMode()
Returns |
boolean
|
isJsonHelpMode()
Returns |
boolean
|
isLoopMode()
Return the loop mode for the config. |
boolean
|
isNoisyDryRunMode()
Return |
boolean
|
runOnAllDevices()
Return true if command should run on all devices. |
void
|
setBugreportOnInvocationEnded(boolean takeBugreport)
Sets whether or not to capture a bugreport at the end of the invocation. |
void
|
setBugreportzOnInvocationEnded(boolean takeBugreportz)
Sets whether or not to capture a bugreportz at the end of the invocation. |
void
|
setInvocationTimeout(Long invocationTimeout)
Set the invocation timeout. |
void
|
setLoopMode(boolean loopMode)
Set the loop mode for the config. |
void
|
setShardCount(Integer shardCount)
Sets the shard count for the command. |
void
|
setShardIndex(Integer shardIndex)
Sets the shard index for the command. |
void
|
setShouldUseSandboxing(boolean use)
Sets whether or not we should use TF containers |
void
|
setTestTag(String testTag)
Sets the test-tag for the invocation. |
boolean
|
shouldSkipPreDeviceSetup()
Return true if the test should skip device setup during TestInvocation setup. |
boolean
|
shouldUseDynamicSharding()
Returns if we should use dynamic sharding or not |
boolean
|
shouldUseSandboxing()
Returns true if we should use Tf containers to run the invocation |
boolean
|
shouldUseTfSharding()
Returns true if we should use Tf new sharding logic |
boolean
|
takeBugreportOnInvocationEnded()
Return true if a bugreport should be taken when the test invocation has ended. |
boolean
|
takeBugreportzOnInvocationEnded()
Return true if a bugreportz should be taken instead of bugreport during the test invocation final bugreport. |
Constants
DRY_RUN_OPTION
public static final String DRY_RUN_OPTION
Constant Value: "dry-run"
NOISY_DRY_RUN_OPTION
public static final String NOISY_DRY_RUN_OPTION
Constant Value: "noisy-dry-run"
USE_SANDBOX
public static final String USE_SANDBOX
Constant Value: "use-sandbox"
Public constructors
CommandOptions
public CommandOptions ()
Public methods
getInvocationData
public UniqueMultiMap<String, String> getInvocationData ()
Returns the data passed to the invocation to describe it
Returns | |
---|---|
UniqueMultiMap<String, String> |
getInvocationTimeout
public long getInvocationTimeout ()
Return the invocation timeout specified. 0 if no timeout to be used.
Returns | |
---|---|
long |
getLoopTime
public long getLoopTime ()
Get the time to wait before re-scheduling this command.
Returns | |
---|---|
long |
time in ms |
getMinLoopTime
public long getMinLoopTime ()
This method is deprecated.
use getLoopTime()
instead
Get the min loop time for the config.
Returns | |
---|---|
long |
getShardCount
public Integer getShardCount ()
Return the total shard count for the command.
Returns | |
---|---|
Integer |
getShardIndex
public Integer getShardIndex ()
Return the shard index for the command.
Returns | |
---|---|
Integer |
getTestTag
public String getTestTag ()
Return the test-tag for the invocation. Default is 'stub' if unspecified.
Returns | |
---|---|
String |
getTestTagSuffix
public String getTestTagSuffix ()
Return the test-tag suffix, appended to test-tag to represents some variants of one test.
Returns | |
---|---|
String |
isDryRunMode
public boolean isDryRunMode ()
Return true
if we should
Returns | |
---|---|
boolean |
isFullHelpMode
public boolean isFullHelpMode ()
Returns true
if full detailed help mode has been requested
Returns | |
---|---|
boolean |
isHelpMode
public boolean isHelpMode ()
Returns true
if abbreviated help mode has been requested
Returns | |
---|---|
boolean |
isJsonHelpMode
public boolean isJsonHelpMode ()
Returns true
if full json help mode has been requested
Returns | |
---|---|
boolean |
isLoopMode
public boolean isLoopMode ()
Return the loop mode for the config.
Returns | |
---|---|
boolean |
isNoisyDryRunMode
public boolean isNoisyDryRunMode ()
Return true
if we should print the command out to the console before we
Returns | |
---|---|
boolean |
runOnAllDevices
public boolean runOnAllDevices ()
Return true if command should run on all devices.
Returns | |
---|---|
boolean |
setBugreportOnInvocationEnded
public void setBugreportOnInvocationEnded (boolean takeBugreport)
Sets whether or not to capture a bugreport at the end of the invocation.
Parameters | |
---|---|
takeBugreport |
boolean |
setBugreportzOnInvocationEnded
public void setBugreportzOnInvocationEnded (boolean takeBugreportz)
Sets whether or not to capture a bugreportz at the end of the invocation.
Parameters | |
---|---|
takeBugreportz |
boolean |
setInvocationTimeout
public void setInvocationTimeout (Long invocationTimeout)
Set the invocation timeout. 0 if no timeout to be used.
Parameters | |
---|---|
invocationTimeout |
Long |
setLoopMode
public void setLoopMode (boolean loopMode)
Set the loop mode for the config.
setShardCount
public void setShardCount (Integer shardCount)
Sets the shard count for the command.
Parameters | |
---|---|
shardCount |
Integer |
setShardIndex
public void setShardIndex (Integer shardIndex)
Sets the shard index for the command.
Parameters | |
---|---|
shardIndex |
Integer |
setShouldUseSandboxing
public void setShouldUseSandboxing (boolean use)
Sets whether or not we should use TF containers
Parameters | |
---|---|
use |
boolean |
setTestTag
public void setTestTag (String testTag)
Sets the test-tag for the invocation.
shouldSkipPreDeviceSetup
public boolean shouldSkipPreDeviceSetup ()
Return true if the test should skip device setup during TestInvocation setup.
Returns | |
---|---|
boolean |
shouldUseDynamicSharding
public boolean shouldUseDynamicSharding ()
Returns if we should use dynamic sharding or not
Returns | |
---|---|
boolean |
shouldUseSandboxing
public boolean shouldUseSandboxing ()
Returns true if we should use Tf containers to run the invocation
Returns | |
---|---|
boolean |
shouldUseTfSharding
public boolean shouldUseTfSharding ()
Returns true if we should use Tf new sharding logic
Returns | |
---|---|
boolean |
takeBugreportOnInvocationEnded
public boolean takeBugreportOnInvocationEnded ()
Return true if a bugreport should be taken when the test invocation has ended.
Returns | |
---|---|
boolean |
takeBugreportzOnInvocationEnded
public boolean takeBugreportzOnInvocationEnded ()
Return true if a bugreportz should be taken instead of bugreport during the test invocation final bugreport.
Returns | |
---|---|
boolean |
Interfaces
Classes
- CommandFileParser
- CommandFileParser.Bitmask
- CommandFileParser.CommandLine
- CommandFileWatcher
- CommandFileWatcher.CommandFile
- CommandOptions
- CommandRunner
- CommandScheduler
- CommandScheduler.CommandTracker
- CommandScheduler.CommandTrackerIdComparator
- Console
- Console.ArgRunnable
- Console.CaptureList
- Verify
Enums
Exceptions