to top
public class

CommandOptions

extends Object
implements ICommandOptions
java.lang.Object
   ↳ com.android.tradefed.command.CommandOptions

Class Overview

Implementation of ICommandOptions.

Summary

Fields
private boolean mAllDevices @Option(name = "all-devices", description = "fork this command to run on all connected devices.")
private boolean mDryRunMode @Option(name = "dry-run", description = "build but don\'t actually run the command. Intended as a quick check to ensure that a command is runnable.", importance = com.android.tradefed.config.Option.Importance.ALWAYS)
private boolean mFullHelpMode @Option(name = "help-all", description = "display the full help text for all options.", importance = com.android.tradefed.config.Option.Importance.ALWAYS)
private boolean mHelpMode @Option(name = "help", description = "display the help text for the most important/critical options.", importance = com.android.tradefed.config.Option.Importance.ALWAYS)
private boolean mJsonHelpMode @Option(name = "json-help", description = "display the full help in json format.")
private boolean mLoopMode @Option(name = "loop", description = "keep running continuously.", importance = com.android.tradefed.config.Option.Importance.ALWAYS)
private Long mMaxRandomLoopTime @Option(name = "max-random-loop-time", description = "the maximum time to wait between invocation attempts when in loop mode. when set, the actual value will be a random number between min-loop-time and this number.", updateRule = com.android.tradefed.config.OptionUpdateRule.LEAST)
private Long mMinLoopTime @Option(name = "min-loop-time", description = "the minimum invocation time in ms when in loop mode.")
private boolean mNoisyDryRunMode @Option(name = "noisy-dry-run", description = "build but don\'t actually run the command. This version prints the command to the console. Intended for cmdfile debugging.", importance = com.android.tradefed.config.Option.Importance.ALWAYS)
private boolean mTakeBugreportOnInvocationEnded @Option(name = "bugreport-on-invocation-ended", description = "take a bugreport when the test invocation has ended")
Public Constructors
CommandOptions()
Public Methods
ICommandOptions clone()
long getLoopTime()
Get the time to wait before re-scheduling this command.
long getMinLoopTime()
Get the min loop time for the config.
boolean isDryRunMode()
Return true if we should skip adding this command to the queue.
boolean isFullHelpMode()
Returns true if full detailed help mode has been requested
boolean isHelpMode()
Returns true if abbreviated help mode has been requested
boolean isJsonHelpMode()
Returns true if full json help mode has been requested
boolean isLoopMode()
Return the loop mode for the config.
boolean isNoisyDryRunMode()
Return true if we should print the command out to the console before we skip adding it to the queue.
boolean runOnAllDevices()
Return true if command should run on all devices.
void setLoopMode(boolean loopMode)
Set the loop mode for the config.
boolean takeBugreportOnInvocationEnded()
Return true if a bugreport should be taken when the test invocation has ended.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.android.tradefed.command.ICommandOptions

Fields

private boolean mAllDevices

private boolean mDryRunMode

private boolean mFullHelpMode

private boolean mHelpMode

private boolean mJsonHelpMode

private boolean mLoopMode

private Long mMaxRandomLoopTime

private Long mMinLoopTime

private boolean mNoisyDryRunMode

private boolean mTakeBugreportOnInvocationEnded

Public Constructors

public CommandOptions ()

Public Methods

public ICommandOptions clone ()

Returns
ICommandOptions

public long getLoopTime ()

Get the time to wait before re-scheduling this command.

Returns
long time in ms

public long getMinLoopTime ()

Get the min loop time for the config.

Returns
long

public boolean isDryRunMode ()

Return true if we should skip adding this command to the queue.

Returns
boolean

public boolean isFullHelpMode ()

Returns true if full detailed help mode has been requested

Returns
boolean

public boolean isHelpMode ()

Returns true if abbreviated help mode has been requested

Returns
boolean

public boolean isJsonHelpMode ()

Returns true if full json help mode has been requested

Returns
boolean

public boolean isLoopMode ()

Return the loop mode for the config.

Returns
boolean

public boolean isNoisyDryRunMode ()

Return true if we should print the command out to the console before we skip adding it to the queue.

Returns
boolean

public boolean runOnAllDevices ()

Return true if command should run on all devices.

Returns
boolean

public void setLoopMode (boolean loopMode)

Set the loop mode for the config.

public boolean takeBugreportOnInvocationEnded ()

Return true if a bugreport should be taken when the test invocation has ended.

Returns
boolean