MemoryUsageMetric.Mode

enum MemoryUsageMetric.Mode : Enum

kotlin.Any
   ↳ kotlin.Enum
     ↳ androidx.benchmark.macro.MemoryUsageMetric.Mode

Summary

Enum Values
Last

Select the last available sample for each value.
Max

Select the maximum value observed.

Public functions
MemoryUsageMetric.Mode
valueOf(value: String)

Returns the enum constant of this type with the specified name.
Array<MemoryUsageMetric.Mode>

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

Public properties
EnumEntries<MemoryUsageMetric.Mode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Enum Values

Last

val MemoryUsageMetric.Mode.Last: MemoryUsageMetric.Mode

Select the last available sample for each value. Useful for inspecting the final state of e.g. Heap Size.

Max

val MemoryUsageMetric.Mode.Max: MemoryUsageMetric.Mode

Select the maximum value observed.

Useful for inspecting the worst case state, e.g. finding worst heap size during a given scenario.

Public functions

valueOf

Added in 1.2.0
fun valueOf(value: String): MemoryUsageMetric.Mode

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.2.0
fun values(): Array<MemoryUsageMetric.Mode>

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.

Public properties

entries

val entries: EnumEntries<MemoryUsageMetric.Mode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.