IDisableable

public interface IDisableable

com.android.tradefed.util.IDisableable

Known indirect subclasses

AbstractTargetCleaner, AdbStopServerPreparer, AdditionalFilesInstaller, AggregatePostProcessor, AllTestAppsInstallSetup, AoaTargetPreparer, AppSetup, AtraceCollector, AtraceRunMetricCollector, AveragePostProcessor, BaseDeviceMetricCollector, BaseMultiTargetPreparer, BasePostProcessor, BaseTargetPreparer, BuddyInfoMetricCollector, and 88 others.

AbstractTargetCleaner	An `ITargetCleaner` class with a stub `setUp(ITestDevice, IBuildInfo)` method
AdbStopServerPreparer	Target preparer to stop adb server on the host before and after running adb tests.
AdditionalFilesInstaller	A `ITargetPreparer` that pushes all `IBuildInfo#getFiles()` to specific path on device.
AggregatePostProcessor	A metric aggregator that gives the min, max, mean, variance and standard deviation for numeric metrics collected during multiple-iteration test runs, treating them as doubles.
AllTestAppsInstallSetup	A `ITargetPreparer` that installs all apps from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
AoaTargetPreparer	`ITargetPreparer` that executes a series of actions (e.g. clicks and swipes) using the Android Open Accessory (AOAv2) protocol.
AppSetup	A `ITargetPreparer` that installs an apk and its tests.
AtraceCollector	A `IMetricCollector` that runs atrace during a test and collects the result and log them to the invocation.
AtraceRunMetricCollector	Collects the traces from all the test directory under the given directory from the test device, log the test directory and post process the trace files under the test directory and aggregate the metrics.
AveragePostProcessor	Implementation of post processor that calculate the average of the list of metrics.
BaseDeviceMetricCollector	Base implementation of `IMetricCollector` that allows to start and stop collection on `onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)` and `ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))`.
BaseMultiTargetPreparer	Base implementation of `IMultiTargetPreparer` that allows to disable the object.
BasePostProcessor	The base `IPostProcessor` that every implementation should extend.
BaseTargetPreparer	Base implementation class for `ITargetPreparer` that allows to control whether the object is disabled or not.
BuddyInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect fragmentation at regular intervals.
BugreportzMetricCollector	A `ScheduledDeviceMetricCollector` to collect zipped bugreport at regular intervals.
BugreportzOnFailureCollector	Collect a bugreportz when a test case fails.
BuildInfoAttributePreparer	A `ITargetPreparer` that adds arbitrary attributes to the `IBuildInfo`.
BuildInfoRecorder	An `ITargetPreparer` that writes build info meta data into a specified file.
CheckPairingPreparer	A `CompanionAwarePreparer` that verifies BT bonding between primary and companion devices
CompanionAllocator	Base class that takes care of allocating and freeing companion device `getCompanionDeviceSelectionOptions()` should be implemented to describe the criteria needed to allocate the companion device
CompanionAwarePreparer	An `ITargetPreparer` that encapsulates the logic of getting an already allocated companion device.
CompanionRunCommandTargetPreparer	A `ITargetPreparer` that runs specified commands on the allocated companion device
CompanionTestAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto an allocated companion device.
ConnectionChecker	Target preparer that waits until an ip address is asigned to any of the specified interfaces.
CpuThrottlingWaiter	An `ITargetPreparer` that waits until max frequency on all cores are restored to highest level available
CrashCollector	A `ITargetPreparer` that runs crash collector on device which suppresses and logs crashes during test execution.
CreateUserPreparer	Target preparer for creating user and cleaning it up at the end.
DebugHostLogOnFailureCollector	Collector that will gather and log the host-side logs when a test case failure occurs.
DeviceBuildInfoInjector	A `ITargetPreparer` that inserts `DeviceBuildDescriptor` metadata into the `IBuildInfo`.
DeviceCleaner	Performs reboot or format as cleanup action after test, and optionally turns screen off
DeviceFlashPreparer	A `ITargetPreparer` that flashes an image on physical Android hardware.
DeviceSetup	A `ITargetPreparer` that configures a device for testing based on provided `Option`s.
DeviceStorageFiller	Target preparer to fill up storage so some amount of free space is available.
DeviceStringPusher	Target preparer to write a string to a file.
DeviceWiper	A `ITargetPreparer` that wipes userdata
DisableSELinuxTargetPreparer	Target preparer that disables SELinux if enabled.
DumpHeapCollector	A `ScheduledDeviceMetricCollector` to collect memory dumps of processes at regular intervals.
EraseUserDataPreparer	A `ITargetPreparer` that wipes user data on the device.
FastbootCommandPreparer	Target preparer that triggers fastboot and sends fastboot commands.
FileCleaner	A `ITargetCleaner` that removes filesystem files on teardown
FilePullerDeviceMetricCollector	A `BaseDeviceMetricCollector` that listen for metrics key coming from the device and pull them as a file from the device.
FilePullerLogCollector	Logger of the file reported by the device-side.
FolderSaver	A `ITargetCleaner` that pulls directories off device, compresses and saves it into logging backend.
GraphicsStatsMetricCollector	A `ScheduledDeviceMetricCollector` to collect graphics stats at regular intervals.
HelloWorldMultiTargetPreparer	An example implementation of a `IMultiTargetPreparer`.
HostStatsdMetricCollector	A `IMetricCollector` that collects statsd metrics from host side using statsd utility commands.
IMetricCollector	This interface will be added as a decorator when reporting tests results in order to collect matching metrics.
IMultiTargetPreparer	Prepares the test environment for several devices together.
IPostProcessor	Post processors is a Trade Federation object meant to allow the processing of metrics and logs AFTER the tests and BEFORE result reporting.
ITargetCleaner	Cleans up the target device after the test run has finished.
ITargetPreparer	Prepares the test environment for the test run.
IncidentReportCollector	Pulls and processes incident reports that are reported device-side.
InstallAllTestZipAppsSetup	A `ITargetPreparer` that installs all apps in a test zip.
InstallApexModuleTargetPreparer
InstallApkSetup	A `ITargetPreparer` that installs one or more apks located on the filesystem.
InstallBuildEnvApkSetup	A `ITargetPreparer` that installs one or more test apks from an Android platform build env.
InstrumentationPreparer	A `ITargetPreparer` that runs instrumentation
IonHeapInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect audio and system memory heaps at regular intervals.
KeyValueConfigPreparer	A `ITargetPreparer` which creates and pushes a simple key/value config file to the device.
LogcatOnFailureCollector	Collector that will capture and log a logcat when a test case fails.
MemInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect memory dumps at regular intervals.
MergeMultiBuildTargetPreparer	A `IMultiTargetPreparer` that allows to pass information from one build to another by naming them and the file key to copy to the other build.
NativeLeakCollector	A `ITargetCleaner` that runs 'dumpsys meminfo --unreachable -a' to identify the unreachable native memory currently held by each process.
NoApkTestSkipper	Special preparer that allows to skip an invocation completely (preparation and tests) if there are no apks to tests.
PagetypeInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect free page counts at regular intervals.
PerfettoPreparer	Perfetto preparer pushes the config file in to the device at a standard location to which perfetto have access.
PerfettoPullerMetricCollector	Base implementation of `FilePullerDeviceMetricCollector` that allows pulling the perfetto files from the device and collect the metrics from it.
PreloadedClassesPreparer	A `ITargetPreparer` that replaces the preloaded classes file on a device.
ProcessMaxMemoryCollector	A `ScheduledDeviceMetricCollector` to measure peak memory usage of specified processes.
PushFileInvoker	A `ITargetPreparer` that pushes files from tests zip onto device, mark them as executable and invokes the binary or script on device.
PushFilePreparer	A `ITargetPreparer` that attempts to push any number of files from any host path to any device path.
PythonVirtualenvPreparer	Sets up a Python virtualenv on the host and installs packages.
RebootReasonCollector	Collector that collects device reboot during the test run and report them by reason and counts.
RebootTargetPreparer	Target preparer that reboots the device.
RemoveSystemAppPreparer	A `ITargetPreparer` for removing an apk from the system partition before a test run.
RestartSystemServerTargetPreparer	Target preparer that restarts the system server without rebooting the device.
RootTargetPreparer	Target preparer that performs "adb root".
RunCommandTargetPreparer
RunHostCommandTargetPreparer	Target preparer to run arbitrary host commands before and after running the test.
RuntimeRestartCollector	Collector that collects timestamps of runtime restarts (system server crashes) during the test run, if any.
ScheduleMultipleDeviceMetricCollector	A `IMetricCollector` that makes runs multiple metric collectors periodically.
ScheduledDeviceMetricCollector	A `IMetricCollector` that allows to run a collection task periodically at a set interval.
ScreenshotOnFailureCollector	Collector that will capture and log a screenshot when a test case fails.
SemaphoreTokenTargetPreparer	This is a preparer used to use token to serialize test excution in tradefed host.
StopServicesSetup	A `ITargetPreparer` that stops services on the device.
StubMultiTargetPreparer	Placeholder empty implementation of a `IMultiTargetPreparer`.
StubTargetPreparer	Placeholder empty implementation of a `ITargetPreparer`.
SuiteApkInstaller	Installs specified APKs for Suite configuration: either from $ANDROID_TARGET_OUT_TESTCASES variable or the ROOT_DIR in build info.
SwitchUserTargetPreparer	A `ITargetPreparer` that switches to the specified user kind in setUp.
TearDownPassThroughPreparer	Allows for running tearDown on preparers that are included in a config as an object.
TemperatureCollector	A `ScheduledDeviceMetricCollector` to measure min and max device temperature.
TemperatureThrottlingWaiter	An `ITargetPreparer` that waits until device's temperature gets down to target
TestAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
TestFilePushSetup	A `ITargetPreparer` that pushes one or more files/dirs from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
TestSystemAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto the /system partition on device.
TimeSetterTargetPreparer	Target preparer to restore the correct time to the device on cleanup.
TimeWaster	A simple target preparer to waste time and potentially restart the device.
TraceCmdCollector	A `IMetricCollector` that collects traces during the test using trace-cmd, and logs them to the invocation.
TraceMetricCollector	A `ScheduledDeviceMetricCollector` to collect kernel debug trace at regular intervals.
UserCleaner	A `ITargetCleaner` that removes secondary users on teardown.
WaitForDeviceDatetimePreparer	A `ITargetPreparer` that waits for datetime to be set on device Optionally this preparer can force a `TargetSetupError` if datetime is not set within timeout, or force host datetime onto device,
WifiPreparer	A `ITargetPreparer` that configures wifi on the device if necessary.

Interface that describes a Tradefed object that can be disabled. A disabled object will be skipped and not called at all.

Summary

Public methods
`default boolean`	`isDisabled()` Returns True if entire object disabled (skip both setup and teardown).
`default boolean`	`isTearDownDisabled()` Returns True if just teardown should be skipped.
`default void`	`setDisable(boolean isDisabled)` Sets whether the object should be disabled.
`default void`	`setDisableTearDown(boolean isDisabled)` Sets whether the teardown step in the object should be skipped.

Public methods

isDisabled

public boolean isDisabled ()

Returns True if entire object disabled (skip both setup and teardown). False otherwise.

Returns
`boolean`

isTearDownDisabled

public boolean isTearDownDisabled ()

Returns True if just teardown should be skipped. False otherwise.

Returns
`boolean`

setDisable

public void setDisable (boolean isDisabled)

Sets whether the object should be disabled. Disabled means that both setup and teardown steps should be skipped. Can be use to make an object disabled by default in the default constructor.

Parameters
`isDisabled`	`boolean`: the state the object should be put in.

setDisableTearDown

public void setDisableTearDown (boolean isDisabled)

Sets whether the teardown step in the object should be skipped. Setup step is still done.

Parameters
`isDisabled`	`boolean`: the state the object should be put in.