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.

CoverageOptions

public final class CoverageOptions
extends Object

java.lang.Object
↳	com.android.tradefed.testtype.coverage.CoverageOptions

Tradefed object to hold coverage options.

Summary

Public constructors
`CoverageOptions()`

Public methods
	`getCoverageProcesses()` Returns the name of processes to flush coverage from after the test has completed.
	`getCoverageToolchains()` Returns the coverage toolchains to collect coverage from.
	`getDeviceCoveragePaths()` Returns the locations on the device where coverage measurements are stored.
`File`	`getJaCoCoAgentPath()` Returns jacocoagent.jar.
`File`	`getLlvmProfdataPath()` Returns the directory containing the llvm-profdata tool.
`String`	`getProfrawFilter()` Returns the prefix of profdata filenames used for coverage measurements.
`long`	`getPullTimeout()` Returns the timeout in milliseconds for pulling coverage metrics from the device.
`boolean`	`isCoverageEnabled()` Returns whether coverage measurements should be collected from this run.
`boolean`	`isCoverageFlushEnabled()` Returns whether coverage measurements should be flushed from running processes after the test has completed.
`boolean`	`shouldMergeCoverage()` Returns whether to merge coverage measurements together before logging.
`boolean`	`shouldResetCoverageBeforeTest()` Returns whether coverage measurements should be reset before each test.

Public constructors

CoverageOptions

public CoverageOptions ()

Public methods

getCoverageProcesses

public  getCoverageProcesses ()

Returns the name of processes to flush coverage from after the test has completed.

Returns
	a `ERROR(/List)` of process names to flush coverage from after the test

getCoverageToolchains

public  getCoverageToolchains ()

Returns the coverage toolchains to collect coverage from.

Returns
	the toolchains to collect coverage from

getDeviceCoveragePaths

public  getDeviceCoveragePaths ()

Returns the locations on the device where coverage measurements are stored.

Returns
	a {link List} containing the device coverage paths

getJaCoCoAgentPath

public File getJaCoCoAgentPath ()

Returns jacocoagent.jar.

Returns
`File`	a `ERROR(/File)` pointing to jacocoagent.jar.

getLlvmProfdataPath

public File getLlvmProfdataPath ()

Returns the directory containing the llvm-profdata tool.

Returns
`File`	a `ERROR(/File)` containing the llvm-profdata tool and its dependencies

getProfrawFilter

public String getProfrawFilter ()

Returns the prefix of profdata filenames used for coverage measurements.

Returns
`String`	a `String` containing the prefix of profdata filenames

getPullTimeout

public long getPullTimeout ()

Returns the timeout in milliseconds for pulling coverage metrics from the device.

Returns
`long`	a `ERROR(/long)` as timeout in milliseconds.

isCoverageEnabled

public boolean isCoverageEnabled ()

Returns whether coverage measurements should be collected from this run.

Returns
`boolean`	whether to collect coverage measurements

isCoverageFlushEnabled

public boolean isCoverageFlushEnabled ()

Returns whether coverage measurements should be flushed from running processes after the test has completed.

Returns
`boolean`	whether to flush processes for coverage measurements after the test

shouldMergeCoverage

public boolean shouldMergeCoverage ()

Returns whether to merge coverage measurements together before logging.

Returns
`boolean`

shouldResetCoverageBeforeTest

public boolean shouldResetCoverageBeforeTest ()

Returns whether coverage measurements should be reset before each test.

Enabling this allows the coverage to be more targeted to the test.

Returns
`boolean`	whether to reset coverage before the test