Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

Class Index

These are the API classes. See all API packages.

A

AaptParser	Class that extracts info from apk by parsing output of 'aapt dump badging'.
AaptParser.AaptVersion	Enum of options for AAPT version used to parse APK files.
Abi	A class representing an ABI.
AbiFormatter	Utility class for abi.
AbiUtils	Utility class for handling device ABIs
AbstractConnection	Abstract connection representation.
AbstractHostMonitor	Typical class for Host Health Monitoring.
AbstractTunnelMonitor	Abstract tunnel monitor for GCE AVD.
AbstractXmlParser	Helper base class for parsing xml files
AbstractXmlParser.ParseException	Thrown if XML input could not be parsed
AcloudConfigParser	Helper class that parse an Acloud config (used to start a Cloud device instance).
AcloudConfigParser.AcloudKeys	Sets of key that can be searched from the configuration.
ActionInProgress	The general action in progress.
ActiveTrace	Main class helping to describe and manage an active trace.
ActivityStatusChecker	Status checker for left over activities running at the end of a module.
AdbRootElevator	An `AutoCloseable` that enables adb root when constructed if needed and restores root state when complete.
AdbSshConnection	Adb connection over an ssh bridge.
AdbStopServerPreparer	Target preparer to stop adb server on the host before and after running adb tests.
AdbTcpConnection	Default connection representation of a device, assumed to be a standard adb connection of the device.
AdbUtils	A utility class for adb operations.
AfterClassWithInfo	Similar guarantees as `AfterClass` but method annotated must require a `TestInformation` parameter.
AggregatePostProcessor	A metric aggregator that gives the min, max, mean, variance, standard deviation, total, count and optionally percentiles 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.
AltDirBehavior	An enum to define alternative directory behaviors for various test artifact installers/pushers
AnalysisHeuristic	Order is important.
AndroidJUnitTest	A Test that runs an instrumentation test package on given device using the android.support.test.runner.AndroidJUnitRunner.
AndroidTestOrchestratorRemoteTestRunner	Runs an instrumented Android test using the adb command and AndroidTestOrchestrator.
AoaTargetPreparer	`ITargetPreparer` that executes a series of actions (e.g. clicks and swipes) using the Android Open Accessory (AOAv2) protocol.
ApkChangeDetector	This class detects whether the APKs to be installed are different from those on the device, in order to decide whether to skip app installation and uninstallation during `ERROR(/TestAppInstallSetup)`'s setUp and tearDown.
AppBuildInfo	A `IBuildInfo` that represents an Android application and its test package(s).
AppDeviceBuildInfo	This class is deprecated. Use `IDeviceBuildInfo` directly.
AppSetup	A `ITargetPreparer` that installs an apk and its tests.
AppVersionFetcher	Utility class to get app version string from device.
AppVersionFetcher.AppVersionInfo	App version info types.
ArchModuleController	Module controller to not run tests when it doesn't match any given architectures.
ArgsOptionParser	Populates `Option` fields from parsed command line arguments.
ArrayUtil	Utility methods for arrays
ArtChrootPreparer	Create chroot directory for ART tests.
ArtGTest
ArtifactDetails	This describes the structure of the content and its descriptor as generated by the CAS tool
ArtifactDetails.ArtifactFileDescriptor
ArtifactsAnalyzer	A utility that helps analyze the build artifacts for insight.
ArtRunTest	A test runner to run ART run-tests.
ArtRunTest.AdbShellCommandException	An exception class to report an error that occurred during the execution of an ADB shell command.
ATestFileSystemLogSaver	This LogSaver class is used by ATest to save logs in a specific path.
AtestRunner	Implementation of `ITestSuite`
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.
AutoLogCollector	Enumeration describing which collector can automatically be handled by the harness.
AutomatedReporters	Class that defines the mapping from Tradefed automated reporters.
AveragePostProcessor	Implementation of post processor that calculate the average of the list of metrics.

B

BackgroundDeviceAction	Runs a command on a given device repeating as necessary until the action is canceled.
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))`.
BaseEmulatorPreparer	Common preparer for launching a local emulator.
BaseHostJUnit4Test	Base test class for running host JUnit4 style tests.
BaseLeveledLogOutput	A base implementation for `ILeveledLogOutput` that allows to filtering some tags based on their name or components.
BaseModuleController	Basic implementation of `IModuleController` that should be implemented for checking if a module should run or not.
BaseMultiTargetPreparer	Base implementation of `IMultiTargetPreparer` that allows to disable the object.
BasePostProcessor	The base `IPostProcessor` that every implementation should extend.
BaseRetryDecision	Base implementation of `IRetryDecision`.
BaseStreamLogger<OS extends OutputStream>	A `ILeveledLogOutput` that directs log messages to an output stream and to stdout.
BaseTargetPreparer	Base implementation class for `ITargetPreparer` that allows to control whether the object is disabled or not.
BaseTestSuite	A Test for running Compatibility Test Suite with new suite system.
BatteryController	Utility class that allows to control the battery charging state of a device.
BatteryRechargeDeviceRecovery	Allow to trigger a command when the battery level of the device goes under a given threshold.
BatteryTemperature
BatteryUnavailableDeviceRecovery	Recovery checker that will trigger a configuration if the battery level is not available.
BeforeClassWithInfo	Similar guarantees as `BeforeClass` but method annotated must require a `TestInformation` parameter.
BinaryState	Enum used to record ON/OFF state with a IGNORE no-op state.
BluetoothConnectionLatencyCollector	The collector will push a pre-defined statsd duration metric config to devices and collect Bluetooth connection duration for each profile.
BluetoothConnectionStateCollector	This collector will collect BluetoothConnectionStateChanged metrics and record connection state number for each profile.
BluetoothConnectionSuccessRatePostProcessor	Implementation of postprocessor which calculates success rate for a bluetooth profile Use "metric-key-match" to specify metrics which contain bluetooth connection states in numeric array Example [0, 1, 2, 3, 0, 1, 2, 3].
BluetoothHciSnoopLogCollector	Collector to enable Bluetooth HCI snoop logging on the DUT and to collect the log for each test.
BluetoothUtils	Utility functions for calling BluetoothInstrumentation on device Device side BluetoothInstrumentation code can be found in AOSP at: `frameworks/base/core/tests/bluetoothtests`
BootstrapBuildProvider	A `IDeviceBuildProvider` that bootstraps build info from the test device This is typically used for devices with an externally supplied build, i.e.
BootstrapServiceFileResolverLoader	Loads resolvers using the service loading facility.
Bugreport	Object holding the bugreport files references, compatible of flat bugreport and zipped bugreport (bugreportz).
BugreportCollector	A pass-through `ITestInvocationListener` that collects bugreports when configurable events occur and then calls `ITestInvocationListener.testLog` on its children after each bugreport is collected.
BugreportCollector.Filter
BugreportCollector.Freq
BugreportCollector.Noun
BugreportCollector.Predicate	A full predicate describing when to capture a bugreport.
BugreportCollector.Relation
BugreportCollector.SubPredicate
BugreportzOnFailureCollector	Collect a bugreportz when a test case fails.
BugreportzOnTestCaseFailureCollector	Collect a bugreportz when a test case in a run fails.
BuildAnalysis	Represents the results of a single build analysis.
BuildError	Thrown if the provided build fails to run.
BuildInfo	Generic implementation of a `IBuildInfo` that should be associated with a `ITestDevice`.
BuildInfoKey	Class holding enumeration related to build information queries.
BuildInfoKey.BuildInfoFileKey	Enum describing all the known file types that can be queried through `IBuildInfo.getFile(com.android.tradefed.build.BuildInfoKey.BuildInfoFileKey)`.
BuildInfoRecorder	An `ITargetPreparer` that writes build info meta data into a specified file.
BuildInfoUtil	A util class to help manipulate `IBuildInfo`
BuildRetrievalError	A fatal error occurred while retrieving the build for testing.
BuildSerializedVersion	Class that contains the current serialization version of all `IBuildInfo`.
BuildTestsZipUtils	A helper class for operations related to tests zip generated by Android build system
BulkEmailer	A email sender utility that allows the following configuration: sent interval,initial burst size, recipients and the total number messages.
BundletoolUtil	Utility class that uses bundletool command line to install the .apks on deivce.
ByteArrayInputStreamSource
ByteArrayList	A class to represent a lightweight byte array.
ByteArrayUtil	Utilities to operate on byte array, e.g., convert bytes to integer.
ByteStreamDownloader	A client implementing the `Read` method of the `ByteStream` gRPC service.
ByteStreamUploader	A client implementing the `Write` method of the `ByteStream` gRPC service.

C

CacheClientFactory	A factory that creates a singleton instance of `ICacheClient`.
CarModuleController	This controller prevents execution of tests cases on non-automotive devices.
CarryDnaeError	Internal `RuntimeException` to carry `DeviceNotAvailableException` through the JUnit4 framework.
CarryInterruptedException	Thrown when test phase timeout is triggered and an InterruptedException needs to be carried from test execution thread to invocation execution thread.
CdmaDeviceFlasher	A class that flashes an image on a physical Android device with a CDMA radio.
CecControllerTokenProvider	Token provider for Consumer Electronics Control (CEC) related tokens.
CentralDirectoryInfo	CentralDirectoryInfo is a class containing the information of a file/folder inside a zip file.
CheckPairingPreparer	A `CompanionAwarePreparer` that verifies BT bonding between primary and companion devices
Chunker	Splits a `blob` into one or more `Chunk`s of at most `chunkSize` bytes.
Chunker.Chunk	A piece of a blob.
CircularAtraceUtil	An atrace utility developed primarily for identifying the root causes of ANRs during Monkey testing.
CircularByteArray	Data structure for holding a fixed size array that operates as a circular buffer, and tracks the total sum of all values in the array.
ClangCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Clang coverage measurements off of the device and log them as test artifacts.
ClangProfileIndexer	A utility class that indexes Clang code coverage measurements.
ClassNotFoundConfigurationException	`ConfigurationException` for when the class of an object is not found.
ClassPathScanner	Finds entries on classpath.
ClassPathScanner.ClassNameFilter	A `IClassPathFilter` that filters and transforms java class names.
ClassPathScanner.ExternalClassNameFilter	A `ClassNameFilter` that rejects inner classes
ClassPathScanner.IClassPathFilter	A filter for classpath entry paths Patterned after `FileFilter`
Client	ResultDB recorder client that uploads test results to ResultDB.
ClockworkUtils	A clockwork utility for sharing multi-device logic
CloseableTraceScope	A scoped class that allows to report tracing section via try-with-resources
ClusterBuildInfo	A `IBuildInfo` class for builds piped from TFC.
ClusterBuildProvider	A `IBuildProvider` to download TFC test resources.
ClusterClient	A `IClusterClient` implementation for interacting with the TFC backend.
ClusterCommand	A class that represents a task fetched from TF Cluster.
ClusterCommand.RequestType
ClusterCommand.State	Command's status in the TF cluster.
ClusterCommandConfigBuilder	A class to build a configuration file for a cluster command.
ClusterCommandEvent	A class to encapsulate cluster command events to be uploaded.
ClusterCommandEvent.Builder
ClusterCommandEvent.Type
ClusterCommandLauncher	A `IRemoteTest` class to launch a command from TFC via a subprocess TF.
ClusterCommandScheduler	A `ICommandScheduler` to support TFC (Tradefed Cluster).
ClusterCommandStatus	A class that represents the state and the cancel reason for a command from TF Cluster.
ClusterDeviceInfo	A class to encapsulate cluster device info to be uploaded.
ClusterDeviceInfo.Builder
ClusterDeviceMonitor	An `IDeviceMonitor` implementation that reports results to the Tradefed Cluster service.
ClusterEventUploader<T extends IClusterEvent>	ClusterEventUploader class, which uploads `IClusterEvent` to TFC.
ClusterHostEvent	A class to encapsulate cluster host events to be uploaded.
ClusterHostEvent.Builder
ClusterHostEvent.HostEventType	Enums of the different types of host events.
ClusterHostUtil	Static util functions for TF Cluster to get global config instances, host information, etc.
ClusterLogSaver	A `ILogSaver` class to upload test outputs to TFC.
ClusterLogSaver.FilePickingStrategy	File picking strategies.
ClusterOptions
CodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Java and native coverage measurements off of the device and log them as test artifacts.
CodeCoverageTest	A Test that runs an instrumentation test package on a given device and generates the code coverage report.
CollectingByteOutputReceiver	A `IShellOutputReceiver` which collects the whole shell output into a `byte[]`.
CollectingOutputReceiver	A `IShellOutputReceiver` which collects the whole shell output into one `String`.
CollectingTestListener	A `ITestInvocationListener` that will collect all test results.
CollectorHelper	Helper to do some `IMetricCollector` operations needed in several places.
CommandBaselineSetter	A common setter to handle device baseline settings via adb shell commands.
CommandFileParser	Parser for file that contains set of command lines.
CommandFileParser.CommandLine
CommandInterrupter	Service allowing TradeFederation commands to be interrupted or marked as uninterruptible.
CommandLineBuildInfoBuilder	Utility meant to capture the usual build information arguments from a command line and create a `IBuildInfo` from them.
CommandOptions	Implementation of `ICommandOptions`.
CommandOptionsGetter	Service implementation that returns the command options value of a given invocation.
CommandResult	Contains the result of a command.
CommandRunner	An alternate TradeFederation entry point that will run command specified in command line arguments and then quit.
CommandRunner.ExitCode	Error codes that are possible to exit with.
CommandScheduler	A scheduler for running TradeFederation commands across all available devices.
CommandScheduler.HostState	Enums of different status of host
CommandStatus	Represents the status of an timed operation.
CommandStatusHandler	Handler helping to monitor and update the status of an invocation.
CommandSuccessModuleController	Base class for a module controller to skip test module based on shell command failure.
CommonLogRemoteFileUtil	This utility allows to avoid code duplication across the different remote device representation for the remote log fetching logic of common files.
CommonLogRemoteFileUtil.KnownLogFileEntry	A representation of a known log entry for remote 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.
CompanionAwareTest	Base test class that encapsulates boilerpate of getting and checking companion device Subclass may call `getCompanion()` to retrieve the allocated companion.
CompanionDeviceTracker	A class for allocating and freeing companion devices
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.
CompileBootImageWithSpeedTargetPreparer	Recompiles the boot classpath and system server with the compiler filter 'speed'.
ConditionFailureMonitor	Monitor for any failures from the invocation.
ConditionPriorityBlockingQueue<T>	A thread-safe class with `ERROR(/PriorityBlockingQueue)`-like operations that can retrieve objects that match a certain condition.
ConditionPriorityBlockingQueue.AlwaysMatch<T>	A `ConditionPriorityBlockingQueue.IMatcher` that matches any object.
ConditionPriorityBlockingQueue.IMatcher<T>	An interface for determining if elements match some sort of condition.
ConfigCompleter	Implementation of the `Completer` for our TF configurations.
ConfigurableGrpcDynamicShardingClient
Configuration	A concrete `IConfiguration` implementation that stores the loaded config objects in a map.
ConfigurationDef	Holds a record of a configuration, its associated objects and their options.
ConfigurationDef.ConfigObjectDef	Object to hold info for a className and the appearance number it has (e.g. if a config has the same object twice, the first one will have the first appearance number).
ConfigurationDescriptor	Configuration Object that describes some aspect of the configuration itself.
ConfigurationDescriptor.LocalTestRunner	Enum used to indicate local test runner.
ConfigurationException	Thrown if configuration could not be loaded.
ConfigurationFactory	Factory for creating `IConfiguration`.
ConfigurationFactory.ConfigLoader	Implementation of IConfigDefLoader that tracks the included configurations from one root config, and throws an exception on circular includes.
ConfigurationFactory.ExceptionLoader
ConfigurationUtil	Utility functions to handle configuration files.
ConfigurationXmlParserSettings	A simple class to accept settings for the ConfigurationXmlParser To pass settings to this class, the alias is mandatory.
ConfigurationYamlParser	Parser for YAML style Tradefed configurations
ConfigUtil	Utility class for creating, interacting with, and pushing statsd configuration files.
ConfigUtil.LogSource
Console	Main TradeFederation console providing user with the interface to interact Currently supports operations such as add a command to test list devices and their state list invocations in progress list commands in queue dump invocation log to file/stdout shutdown
Console.ArgRunnable<T>	A `Runnable` with a `run` method that can take an argument
Console.CaptureList	A convenience type for `List<List<String>>`
ConsoleReaderOutputStream	An OutputStream that can be used to make `System.out.print()` play nice with the user's `LineReader` unfinishedLine.
ConsoleResultReporter	Result reporter to print the test results to the console.
ContentAnalysisContext	Provide the context surrounding a content to analyze it properly.
ContentAnalysisContext.AnalysisMethod	This describes what to expect from the content structure for proper analysis.
ContentAnalysisResults	Summary of the content analysis.
ContentInformation	Represents the content for a given build target of its base and current version.
ContentMerkleTree	Compute a MerkleTree from the content information.
ContentModuleLister	Compute a module list from the context.
ContentProviderHandler	Handler that abstract the content provider interactions and allow to use the device side content provider for different operations.
CountingTestResultListener	A `TestResultListener` that tracks the total number of tests by `TestStatus`
CountTestCasesCollector	Count and report the number of test cases for a given `IRemoteTest`.
CoverageMeasurementForwarder	A placeholder test that forwards coverage measurements from the build provider to the logger.
CoverageOptions	Tradefed object to hold coverage options.
CoverageOptions.Toolchain
CpuThrottlingWaiter	An `ITargetPreparer` that waits until max frequency on all cores are restored to highest level available
CreateAvdPreparer
CreateUserPreparer	Target preparer for creating user and cleaning it up at the end.
CurrentInvocation	A class that tracks and provides the current invocation information useful anywhere inside the invocation.
CurrentInvocation.InvocationInfo	Some special named key that we will always populate for the invocation.
CurrentInvocation.IsolationGrade	Describes the level of isolation

D

DebugHostLogOnFailureCollector	Collector that will gather and log the host-side logs when a test case failure occurs.
DefaultConnection	Default connection representation of a device, assumed to be a standard adb connection of the device.
DefaultConnection.ConnectionBuilder	Builder used to described the connection.
DefaultRemoteAndroidTestRunner	Extension of the ddmlib `RemoteAndroidTestRunner` to set some default for Tradefed use cases.
DefaultTestsZipInstaller	A default implementation of tests zip installer.
DelegatedInvocationExecution	`InvocationExecution` which delegate the execution to another Tradefed binary.
DependenciesResolver	A new type of provider that allows to get all the dependencies for a test.
DeviceActionTargetPreparer	A `ITargetPreparer` to perform device actions.
DeviceActionUtil	A Utility class to execute device actions.
DeviceActionUtil.Command	Commands for device action.
DeviceActionUtil.DeviceActionConfigError	Exception for config error.
DeviceAllocationResult	Represents the results of an allocation attempt for a command.
DeviceAllocationState	Represents the allocation state of the device from the IDeviceManager perspective
DeviceAvailableChecker	Checker to ensure a module doesn't leave the device in an offline state.
DeviceBaselineChecker	Set device baseline settings before each module.
DeviceBaselineSetter	Abstract class used to create a device baseline setting.
DeviceBatteryLevelChecker	An `IRemoteTest` that checks for a minimum battery charge, and waits for the battery to reach a second charging threshold if the minimum charge isn't present.
DeviceBatteryResourceMetricCollector	This collector collects device battery metrics.
DeviceBuildDescriptor	A wrapper class for a `IBuildInfo`, that contains helper methods to retrieve device platform build information.
DeviceBuildInfo	A `IBuildInfo` that represents a complete Android device build and (optionally) its tests.
DeviceBuildInfoBootStrapper	A `ITargetPreparer` that replaces build info fields with attributes read from device This is useful for testing devices with builds generated from an external source (e.g.
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
DeviceCleaner.CleanupAction
DeviceCleaner.PostCleanupAction
DeviceConcurrentUtil	Contains utility methods and classes for concurrent device side command execution Use `ERROR(/ExecutorService)` to run commands implemented as `ShellCommandCallable`, and use `ERROR(/#joinFuture(String,Future,long))` for synchronization against the `ERROR(/Future)` as returned by `ERROR(/ExecutorService)` for the command execution.
DeviceConcurrentUtil.ShellCommandCallable<V>	A `ERROR(/Callable)` that wraps the details of executing shell command on an `ITestDevice`.
DeviceConfigurationHolder	A concrete `IDeviceConfiguration` implementation that stores the loaded device configuration objects in its attributes.
DeviceDescriptor	A class containing information describing a device under test.
DeviceDisconnectedException	Thrown when a device is no longer reachable via it's transport type, e.g. if the device is no longer visible via USB, or TCP/IP connection
DeviceErrorIdentifier	Error Identifiers from Device errors and device reported errors.
DeviceFailedToBootError	Thrown if a device fails to boot after being flashed with a build.
DeviceFeatureFlag
DeviceFeatureModuleController	A module controller to not run tests when it doesn't support certain feature.
DeviceFileReporter	A utility class that checks the device for files and sends them to `ITestInvocationListener.testLog(String, LogDataType, InputStreamSource)` if found.
DeviceFlashPreparer	A `ITargetPreparer` that flashes an image on physical Android hardware.
DeviceFoldableState	Representation of device foldable state as returned by "cmd device_state print-states".
DeviceFolderBuildInfo	A `IDeviceBuildInfo` that also contains other build artifacts contained in a directory on the local filesystem.
DeviceImageTracker	For some of the incremental device update, we need the baseline files to compute diffs.
DeviceImageTracker.FileCacheTracker	Track information of the device image cached and its metadata
DeviceImageZipFlashingTargetPreparer	A target preparer that flashes the device with device images provided via a specific format.
DeviceInspectionResult	A class contains the device inspection result when a device becomes unavailable.
DeviceInternetAccessibilityResourceMetricCollector	The collector pings google.com to check if the device has internet accessibility or not.
DeviceJUnit4ClassRunner	JUnit4 test runner that also accommodates `IDeviceTest`.
DeviceJUnit4ClassRunner.LogAnnotation	Fake annotation meant to carry logs to the reporters.
DeviceJUnit4ClassRunner.MetricAnnotation	Fake annotation meant to carry metrics to the reporters.
DeviceJUnit4ClassRunner.TestLogData	Implementation of `ExternalResource` and `TestRule`.
DeviceJUnit4ClassRunner.TestMetrics	Implementation of `ExternalResource` and `TestRule`.
DeviceManagementGrpcServer	GRPC server allowing to reserve a device from Tradefed.
DeviceManager
DeviceManager.FastbootDevice	Representation of a device in Fastboot mode.
DeviceMerkleTree	Compute a MerkleTree from the device content information.
DeviceMetricData	Object to hold all the data collected by metric collectors.
DeviceMonitorMultiplexer	A proxy class to propagate requests to multiple `IDeviceMonitor`s.
DeviceNotAvailableException	Thrown when a device is no longer available for testing.
DeviceOwnerTargetPreparer	An `ITargetPreparer` that sets up a device owner component.
DeviceParameterizedRunner	JUnit4 style parameterized runner for host-side driven parameterized tests.
DeviceProperties	Common constant definitions for device side property names
DeviceRecoveryModeUtil
DeviceReleaseReporter	Device release reporter that handles communicating with the parent process the device(s) to be released.
DeviceResetFeature	Server side implementation of device reset.
DeviceResetHandler	Utility handling generically device resetting.
DeviceRuntimeException	Thrown when a device action did not results in the expected results.
DeviceSelectionOptions	Container for for device selection criteria.
DeviceSelectionOptions.DeviceRequestedType	The different possible types of placeholder devices supported.
DeviceSettingChecker	Check if device settings have changed during a module run.
DeviceSetup	A `ITargetPreparer` that configures a device for testing based on provided `Option`s.
DeviceSnapshotFeature	Server side implementation of device snapshot.
DeviceSnapshotHandler	Utility handling Cuttlefish snapshot.
DeviceStateMonitor	Helper class for monitoring the state of a `IDevice`.
DeviceStorageAgeResourceMetricCollector	Parse storage age from logcat.
DeviceStorageFiller	Target preparer to fill up storage so some amount of free space is available.
DeviceStorageStatusChecker	Check if device has enough disk space for the given partitions.
DeviceStringPusher	Target preparer to write a string to a file.
DeviceSuite	Extends the JUnit4 container `Suite` in order to provide a `ITestDevice` to the tests that requires it.
DeviceSyncHelper	Helper that helps syncing a new device image to the device.
DeviceTestCase	Helper JUnit test case that provides the `IRemoteTest` and `IDeviceTest` services.
DeviceTestResult	An specialization of `TestResult` that will abort when a `DeviceNotAvailableException` occurs
DeviceTestResult.RuntimeDeviceNotAvailableException
DeviceTestRunOptions	A builder class for options related to running device tests through BaseHostJUnit4Test.
DeviceTestSuite	Helper JUnit test suite that provides the `IRemoteTest` and `IDeviceTest` services.
DeviceTraceCollector	Collector that will start perfetto trace when a test run starts and log trace file at the end.
DeviceUnavailableMonitor	This listener attempts to capture a test case level DNAE only.
DeviceUnresponsiveException	A specialization of `DeviceNotAvailableException` that indicates device is visible to adb, but is unresponsive (i.e., commands timing out, won't boot, etc)
DeviceUpdateTargetPreparer	An abstract `ITargetPreparer` that takes care of common steps around updating devices with a device image file from an external source (as opposed to a build service).
DeviceWifiResourceMetricCollector	The collector collects current connected wifi signal strength and link speed metrics.
DeviceWiper	A `ITargetPreparer` that wipes userdata
DigestCalculator	Utility methods to compute `Digest`.
DirectedGraph<V>	A directed unweighted graphs implementation.
DisableSELinuxTargetPreparer	Target preparer that disables SELinux if enabled.
DryRunKeyStore	A keystore for dry-run where any keystore value is always properly replaced and found.
DryRunner	Transparently dry runs tests instead of actually executing them.
DynamicFileStubTest	This is a tradefed test to test tradefed can resolve dynamic file correctly.
DynamicRemoteFileResolver	Class that helps resolving path to remote files.
DynamicRemoteFileResolver.FileResolverLoader	Loads implementations of `IRemoteFileResolver`.
DynamicShardHelper	Sharding strategy to allow work remote work queueing between multiple TF instances
DynamicShardingConnectionInfoMessage	Data-holding class in order to make sending via the feature server easier.
DynamicSystemPreparer	An `ITargetPreparer` that sets up a system image on top of a device build with the Dynamic System Update.

E

EarlyDeviceReleaseFeature	Feature server implementation for early device release.
Email	A helper class to send an email.
EmailHostHealthAgent	A `IHostHealthAgent` implementation to send email from Host monitor reports
EmmaXmlConstants	Constants used when parsing emma xml report.
EmulatorMemoryCpuCapturer
EndCentralDirectoryInfo	EndCentralDirectoryInfo is a class containing the overall information of a zip file.
EnforcedSeLinuxChecker	Status checker that ensures the status of Selinux.
EnvironmentVariableUtil	A collection of helper methods to prepare environment variables.
EraseUserDataPreparer	A `ITargetPreparer` that wipes user data on the device.
ErrorIdentifier	This interface describes a specific error and its properties.
ErrorStorageUtil	Helper class for manipulating the errors to align with the common storage.
EventsLoggerListener	Listener that logs all the events it receives into a file
ExceptionThrowingRunnerWrapper
ExecutableAction	A value class representing an action which can be executed.
ExecutableActionResult	A value class representing a result of a `ExecutableAction`.
ExecutableBaseTest	Base class for executable style of tests.
ExecutableHostTest	Test runner for executable running on the host.
ExecutableTargetTest	Test runner for executable running on the target.
ExecutionFiles	Files dependencies generated during the execution of a test or invocation that need to be carried for testing.
ExecutionFiles.FilesKey	Enumeration of known standard key for the map.
ExecutionProperties	Properties generated during the execution of a test or invocation.
ExistingBuildProvider	A `IBuildProvider` that returns an already constructed `IBuildInfo`.
ExtendedFile	A extension of standard file to carry a build related metadata.
ExtensionAtomsRegistry	ExtensionAtomsRegistry for local use of statsd.

F

FailureDescription	The class describing a failure information in Trade Federation.
FakeTest	A fake test whose purpose is to make it easy to generate repeatable test results.
FakeTestsZipFolder	A testing fixture that creates a fake unzipped tests folder based on a list of content.
FakeTestsZipFolder.ItemType
FastbootCommandPreparer	Target preparer that triggers fastboot and sends fastboot commands.
FastbootDeviceFlasher	A class that relies on fastboot to flash an image on physical Android hardware.
FastbootHelper	A helper class for fastboot operations.
FastbootPack	Follow the specification of bootloader to unpack it.
FastbootUpdateBootstrapPreparer	An `ITargetPreparer` that stages specified files (bootloader, radio, device image zip) into `IDeviceBuildInfo` to get devices flashed with `FastbootDeviceFlasher`, then injects post-boot device attributes into the build info for result reporting purposes.
FatalHostError	An exception that indicates a fatal unrecoverable error has occurred on the host machine running TradeFederation, and that the TradeFederation instance should be shut down.
FeatureFlagTargetPreparer	Updates the DeviceConfig (feature flags tuned by a remote service).
FileDownloadCache	A helper class that maintains a local filesystem LRU cache of downloaded files.
FileDownloadCacheFactory	A factory for creating `FileDownloadCache`
FileDownloadCacheWrapper	A wrapper class that provides `FileDownloadCache` facilities while implementing the `IFileDownloader` interface.
FileIdleMonitor	Monitors files and executes a callback if they have been idle (i.e.
FileInputStreamSource	A `InputStreamSource` that takes an input file.
FileLogger	A `ILeveledLogOutput` that directs log messages to a file and to stdout.
FileProtoResultReporter	Proto reporter that dumps the `TestRecord` into a file.
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.
FileSystemLogSaver	Save logs to a file system.
FilesystemRootChecker
FileUtil	A helper class for file related operations
FileUtil.LowDiskSpaceException	Thrown if usable disk space is below minimum threshold.
FilteredResultForwarder	Variant of `ResultForwarder` that only allows an allowlist of `TestDescription` to be reported.
FixedByteArrayOutputStream	An in-memory `ERROR(/OutputStream)` that only keeps a maximum amount of data.
FlashingMethod	An enum to describe the method used to flash device under test
FlashingResourcesParser	A class that parses out required versions of auxiliary image files needed to flash a device.
FlashingResourcesParser.AndroidInfo	A typedef for `Map<String, MultiMap<String, String>>`.
FlashingResourcesParser.Constraint	A filtering interface, intended to allow `FlashingResourcesParser` to ignore some resources that it otherwise might use
FlashingResourceUtil	This utility helps setting the appropriate version of artifacts so they can be flashed via `DeviceFlashPreparer`.
FoldableExpandingHandler	A `IModuleParameterHandler` expanding into more for each non-primary foldable configuration.
FoldableHandler	Generic foldable handler that can take the foldable parameters to create a specialized module.
FoldableModePreparer	A target preparer that can switch the foldable state of a device.
FolderBuildInfo	Concrete implementation of a `IFolderBuildInfo`.
FolderSaver	A `ITargetPreparer` that pulls directories off device, compresses and saves it into logging backend.
FormattedGeneratorReporter	Reporter that allows to generate reports in a particular format.
FreeDeviceState
FuseUtil	A helper class for FUSE operations.

G

GceAvdInfo	Structure to hold relevant data for a given GCE AVD instance.
GceAvdInfo.GceStatus
GceAvdInfo.LogFileEntry
GceLHPTunnelMonitor	Thread Monitor for the Gce lab host proxy tunnel used for oxygenation.
GceManager	Helper that manages the GCE calls to start/stop and collect logs from GCE.
GceRemoteCmdFormatter	Utility class to format commands to reach a remote gce device.
GceRemoteCmdFormatter.ScpMode	SCP can be used to push or pull file depending of the structure of the args.
GceSshTunnelMonitor	Thread Monitor for the Gce ssh tunnel.
GcovCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull gcov coverage measurements off of the device and log them as test artifacts.
GcovKernelCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull gcov kernel coverage measurements out of debugfs and off of the device and then finally logs them as test artifacts.
GCSBucketUtil	File manager to download and upload files from Google Cloud Storage (GCS).
GCSBucketUtil.GCSFileMetadata	Simple wrapper for file info in GCS.
GCSCommon	Obsoleted! Use com.android.tradefed.util.gcs.GCSCommon instead.
GCSCommon	Base class for Gcs operation like download and upload.
GCSConfigurationFactory	A `ConfigurationFactory` loads configs from Google Cloud Storage.
GCSConfigurationFactory.GCSConfigLoader	Extension of `ConfigurationFactory.ConfigLoader` that loads config from GCS, tracks the included configurations from one root config, and throws an exception on circular includes.
GCSConfigurationServer	Config server loads configs from Google Cloud Storage (GCS).
GCSDownloaderHelper	Downloader for GCS bucket that takes care of caching and resolving the global config.
GCSFileDownloader	File downloader to download file from google cloud storage (GCS).
GCSFileDownloaderBase	File downloader to download file from google cloud storage (GCS).
GCSFileUploader	File uploader to upload file data to google cloud storage (GCS).
GCSHelper
GCSHostResourceManager	Download host resource from GCS (Google cloud storage).
GcsRemoteFileResolver	Implementation of `IRemoteFileResolver` that allows downloading from a GCS bucket.
GenericLogcatEventParser<LogcatEventType>	Parse logcat input for events.
GenericLogcatEventParser.LogcatEvent	Struct to hold a logcat event with the event type and triggering logcat message
GetPreviousPassedHelper	Helper to get the previous passed test filters.
GkiDeviceFlashPreparer	A target preparer that flash the device with android common kernel generic image.
GlobalConfiguration	An `IGlobalConfiguration` implementation that stores the loaded config objects in a map
GlobalFilterGetter	Service implementation that returns the filters of a given invocation.
GlobalTestFilter	Filter options applied to the invocation.
GoogleApiClientUtil	Utils for create Google API client.
GoogleApiClientUtilBase
GoogleBenchmarkResultParser	Parses the results of Google Benchmark that run from shell, and return a map with all the results.
GoogleBenchmarkTest	A Test that runs a Google benchmark test package on given device.
GranularRetriableTestWrapper	A wrapper class works on the `IRemoteTest` to granulate the IRemoteTest in testcase level.
GranularRetriableTestWrapper.StartEndCollector	Class helper to catch missing run start and end.
GsiDeviceFlashPreparer	A target preparer that flashes the device with android generic system image.
GTest	A Test that runs a native test package on given device.
GTestBase	The base class of gTest
GTestListTestParser	A result parser for gtest dry run mode with "--gtest_list_tests" parameter.
GTestResultParser	Parses the 'raw output mode' results of native tests using GTest that run from shell, and informs a ITestInvocationListener of the results.
GTestXmlResultParser	Parses the 'xml output mode' results of native tests using GTest that run from shell, and informs a ITestRunListener of the results.

H

HarnessException	Base exception class for exception thrown within the harness.
HarnessIOException	Harness exception that helps carrying file issues.
HarnessRuntimeException
HeapHostMonitor	`AbstractHostMonitor` implementation that monitors the heap memory on the host and log it periodically to the history log.
HelloWorldMultiTargetPreparer	An example implementation of a `IMultiTargetPreparer`.
HistoryLogger	TF History Logger, special log that contains only some specific events.
HostGTest	A Test that runs a native test package.
HostMetric	This class represents a host metric sample to be reported.
HostOptions	Host options holder class.
HostStatsdMetricCollector	A `IMetricCollector` that collects statsd metrics from host side using statsd utility commands.
HostTest	A test runner for JUnit host based tests.
HostUtils	Implements some useful utility methods for running host tests.
HprofAllocSiteParser	Helper class to parse info from an Allocation Sites section of hprof reports.
HttpHelper	Contains helper methods for making http requests
HttpHelper.RequestRunnable	Runnable for making requests with `IRunUtil.runEscalatingTimedRetry(long, long, long, long, IRunnableResult)`.
HttpMultipartPost	Helper class for making multipart HTTP post requests.
HttpRemoteFileResolver	Implementation of `IRemoteFileResolver` that allows downloading remote file via http
HttpsRemoteFileResolver	Implementation of `IRemoteFileResolver` that allows downloading remote file via https

I

IAbi	Interface representing the ABI under test.
IAbiReceiver	A test that needs the ABI under test.
IAndroidDebugBridge	Interface definition for `AndroidDebugBridge` methods used in this package.
IAppBuildInfo	This interface is deprecated. Use `IBuildInfo` directly.
IAutoRetriableTest	Interface for an `IRemoteTest` that doesn't implement `ITestFilterReceiver` but still wishes to support auto-retry.
IBatteryInfo	The interface defining the interaction with a battery of a device.
IBatteryInfo.BatteryState	Describes the current battery charging state.
IBuildInfo	Holds information about the build under test.
IBuildInfo.BuildInfoProperties	Some properties that a `IBuildInfo` can have to tweak some handling of it.
IBuildProvider	Responsible for providing info regarding the build under test.
IBuildReceiver	A test that needs reference to the build under test.
ICacheClient	An interface for a cache client.
IClusterClient	An interface for interacting with the TFC backend.
IClusterEvent	Interface for any cluster event to be uploaded to TFC.
IClusterEventUploader<T extends IClusterEvent>	Interface for ClusterEventUploader
IClusterOptions	An interface for getting cluster-related options.
ICommandOptions	Container for execution options for commands.
ICommandScheduler	A scheduler for running TradeFederation commands.
ICommandScheduler.IScheduledInvocationListener	Listener for invocation events when invocation completes.
ICompressionStrategy	An interface representing a compression algorithm that can be selected at runtime.
IConfigOptionValueTransformer	An interface for manipulating config option value
IConfigurableVirtualDevice	An interface to provide information about a possibly preconfigured virtual device info (host ip, host user, ports offset and etc.).
IConfiguration	Configuration information for a TradeFederation invocation.
IConfigurationFactory	Factory for creating `IConfiguration`s
IConfigurationReceiver	Simple interface to represent object that accepts an `IConfiguration`.
IConfigurationServer	An interface for config server.
ICredentialFactory	An interface for credential factory to create oauth2 `Credential`.
IDefaultObjectLoader	Interface for loading the default objects that should be part of our YAML configuration.
IDefaultObjectLoader.LoaderConfiguration	The loading configuration object to pass information to the loader.
IDeviceActionReceiver	Provides an API to receive device events.
IDeviceBuildInfo	A `IBuildInfo` that represents a complete Android device build and (optionally) its tests.
IDeviceBuildProvider	A `IBuildProvider` that uses information from a `ITestDevice` to retrieve a build.
IDeviceConfiguration	Device Configuration Holder Interface.
IDeviceFlasher	Flashes a device image on a device.
IDeviceFlasher.UserDataFlashOption	Enum of options for handling the userdata image
IDeviceManager	Interface for managing the set of available devices for testing.
IDeviceManager.IFastbootListener	A listener for fastboot state changes.
IDeviceMonitor	Interface for monitoring state of devices.
IDeviceMonitor.DeviceLister	A `Runnable`-like class that should return the known devices and their states.
IDeviceRecovery	Interface for recovering a device that has gone offline.
IDeviceSelection	Interface for device selection criteria.
IDeviceSelection.BaseDeviceType
IDeviceStateMonitor	Provides facilities for monitoring the state of a `IDevice`.
IDeviceTest	Interface for object that needs a reference to a `ITestDevice`.
IDisableable	Interface that describes a Tradefed object that can be disabled.
IDynamicShardingClient	Wrapper interface for the sharding client This exists so that we can swap in an HTTP one or testing one if needed.
IDynamicShardingConnectionInfo	Interface for classes that contain dynamic sharding connection info
IEmail	Interface for sending email.
IEmail.Message	Container for email message data.
IFileDownloader	Interface for downloading a remote file.
IFileEntry	Interface definition that provides simpler, mockable contract to `FileEntry` methods.
IFileResolverLoader	Loads implementations of `IRemoteFileResolver`.
IFileResolverLoader.ResolverLoadingException	Exception thrown if a resolver cannot be loaded or initialized.
IFlashingResourcesParser	Interface for providing required versions of auxiliary image files needed to flash a device.
IFlashingResourcesRetriever	Interface for retrieving auxiliary image files needed to flash a device.
IFolderBuildInfo	A simple abstract `IBuildInfo` whose build artifacts are containing in a local filesystem directory.
IFormatterGenerator	Interface describing a formatter for `SuiteResultHolder`.
IGlobalConfiguration	A class to encompass global configuration information for a single Trade Federation instance (encompassing any number of invocations of actual configurations).
IHarnessException	Description of the harness exception interface that will be implemented by harness exceptions.
IHostCleaner	Cleans up the host after the test run has finished.
IHostHealthAgent	An interface to emit host or device metrics.
IHostMonitor	Interface to dispatch host data
IHostMonitor.HostDataPoint	Generic class for data to be reported.
IHostMonitor.HostMetricType
IHostOptions	Host options holder interface.
IHostOptions.PermitLimitType	Enum describing the possible permit limiters
IHostResourceManager	Interface to manager host resource.
IHttpHelper	Helper methods for performing http requests.
IHttpHelper.DataSizeException
IIncrementalSetup	An interface which helps decide whether to attempt incremental setup for TradeFed preparers.
IInvocationContext	Holds information about the Invocation for the tests to access if needed.
IInvocationContext.TimingEvent
IInvocationContextReceiver	A test that needs reference to the context of the invocation.
IInvocationExecution	Interface describing the actions that will be done as part of an invocation.
IKeyStoreClient	Interface to access a key store for password or sensitive data.
IKeyStoreFactory	Factory for creating `IKeyStoreClient`.
ILabPreparer	Marker interface for lab preparers See `ITargetPreparer` for a description of what these interfaces are intended.
ILeveledLogOutput	Classes which implement this interface provides methods that deal with outputting log messages.
ILogcatReceiver	A class that provides the output of a device's logcat as an `InputStreamSource`.
ILogRegistry	An interface for a `ILogOutput` singleton logger that multiplexes and manages different loggers.
ILogRegistry.EventType	Events that are useful to be logged
ILogSaver	Classes which implement this interface provide methods for storing logs to a central location.
ILogSaverListener	Allows for `ITestInvocationListener`s to listen for when log files are saved.
ImageContentAnalyzer	Analyzer for device image content analysis
IManagedTestDevice	A ITestDevice whose lifecycle is managed.
IManagedTestDevice.DeviceEventResponse	Container for a response to a `IManagedTestDevice.handleAllocationEvent(DeviceEvent)` call
IManagedTestDeviceFactory	Creator interface for `IManagedTestDevice`s
IMetricCollector	This interface will be added as a decorator when reporting tests results in order to collect matching metrics.
IMetricCollectorReceiver	Interface for `IRemoteTest`s to implement if they need to get the list of `IMetricCollector`s for the test run.
IMoblyYamlResultHandler	Interface of mobly yaml result handler.
IMoblyYamlResultHandler.ITestResult	Interface of mobly yaml result
IModuleController	Interface for controlling if a module should be executed or not.
IModuleController.RunStrategy	Enum describing how the module should be executed.
IModuleParameterHandler	The interface for parameters of suites modules.
IMultiDeviceRecovery	Interface for recovering multiple offline devices.
IMultiDeviceTest	This interface is deprecated. This interface is kept temporarily for compatibility but is not actually used anymore. Please do not implement it.
IMultiTargetPreparer	Prepares the test environment for several devices together.
INativeDevice	Provides an reliable and slightly higher level API to a ddmlib `IDevice`.
INativeDeviceTest	Interface for object that needs a reference to a `INativeDevice`.
IncrementalImageUtil	A utility to leverage the incremental image and device update.
InfraErrorIdentifier	Error Identifiers from Trade Federation infra, and dependent infra (like Build infra).
InputStreamSource	This interface basically wraps an `ERROR(/InputStream)` to make it clonable.
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.
InstalledInstrumentationsTest	Runs all instrumentation found on current device.