MemoryUsageMetric.Mode
public enum MemoryUsageMetric.Mode extends Enum
Summary
Enum Values |
|
|---|---|
Last |
Select the last available sample for each value. |
Max |
Select the maximum value observed. |
Public methods |
|
|---|---|
final @NonNull EnumEntries<@NonNull MemoryUsageMetric.Mode> |
Returns an immutable |
static final @NonNull MemoryUsageMetric.Mode |
Returns the enum constant of this type with the specified name. |
static final @NonNull MemoryUsageMetric.Mode[] |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Last
MemoryUsageMetric.Mode MemoryUsageMetric.Mode.Last
Select the last available sample for each value. Useful for inspecting the final state of e.g. Heap Size.
Max
MemoryUsageMetric.Mode MemoryUsageMetric.Mode.Max
Select the maximum value observed.
Useful for inspecting the worst case state, e.g. finding worst heap size during a given scenario.
Public methods
getEntries
public final @NonNull EnumEntries<@NonNull MemoryUsageMetric.Mode> getEntries()
Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.
valueOf
public static final @NonNull MemoryUsageMetric.Mode 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
public static final @NonNull MemoryUsageMetric.Mode[] 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.