InProcessTracingMode

Artifact: androidx.benchmark:benchmark-common

Kotlin |Java

@ExperimentalBenchmarkConfigApi
public enum InProcessTracingMode extends Enum

java.lang.Object
↳	kotlin.Enum
	↳	androidx.benchmark.InProcessTracingMode

Configuration for in-process tracing.

By passing this object in MacrobenchmarkRule you can enable capture of in-process traces.

Summary

Enum Values
`Disable`	Do not include in-process traces.
`Require`	Enable in-process tracing, which requires the target application to include the `androidx.tracing:tracing-wire` dependency.
`UseIfAvailable`	Enable in-process tracing if the app depends on `androidx.tracing:tracing-wire`.

Public methods
`final @NonNull EnumEntries<@NonNull InProcessTracingMode>`	`getEntries()` Returns an immutable `kotlin.enums.EnumEntries` list containing the constants of this enum type, in the order they're declared.
`static final @NonNull InProcessTracingMode`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`static final @NonNull InProcessTracingMode[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

Disable

@ExperimentalBenchmarkConfigApi
InProcessTracingMode InProcessTracingMode.Disable

Do not include in-process traces.

Require

@ExperimentalBenchmarkConfigApi
InProcessTracingMode InProcessTracingMode.Require

Enable in-process tracing, which requires the target application to include the androidx.tracing:tracing-wire dependency.

If androidx.tracing:tracing-wire is not present in the target application, an exception is thrown during the benchmark.

UseIfAvailable

@ExperimentalBenchmarkConfigApi
InProcessTracingMode InProcessTracingMode.UseIfAvailable

Enable in-process tracing if the app depends on androidx.tracing:tracing-wire.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull InProcessTracingMode> getEntries()

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

valueOf

Added in 1.5.0-beta01

public static final @NonNull InProcessTracingMode valueOf(@NonNull String value)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

Added in 1.5.0-beta01

public static final @NonNull InProcessTracingMode[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.