# StartupMode

Artifact: [androidx.benchmark:benchmark-macro](https://developer.android.com/jetpack/androidx/releases/benchmark) [View Source](https://cs.android.com/search?q=file:androidx/benchmark/macro/StartupMode.kt+class:androidx.benchmark.macro.StartupMode) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/benchmark#1.1.0)

*** ** * ** ***


```
enum StartupMode : Enum<StartupMode>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[StartupMode](https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode)\> ||
|   | ↳ | [androidx.benchmark.macro.StartupMode](https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode) |

*** ** * ** ***

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#COLD` | Startup from scratch - app's process is not alive, and must be started in addition to Activity creation. |
| `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#HOT` | Bring existing activity to the foreground, process and Activity still exist from previous launch. |
| `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#WARM` | Create and display a new Activity in a currently running app process. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode` | `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode>` | `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode>` | `https://developer.android.com/reference/kotlin/androidx/benchmark/macro/StartupMode#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. |

## Enum Values

### COLD

```
val StartupMode.COLD: StartupMode
```

Startup from scratch - app's process is not alive, and must be started in addition to Activity creation.

See [Cold startup documentation](https://developer.android.com/topic/performance/vitals/launch-time#cold)

### HOT

```
val StartupMode.HOT: StartupMode
```

Bring existing activity to the foreground, process and Activity still exist from previous launch.

See [Hot startup documentation](https://developer.android.com/topic/performance/vitals/launch-time#hot)

### WARM

```
val StartupMode.WARM: StartupMode
```

Create and display a new Activity in a currently running app process.

See [Warm startup documentation](https://developer.android.com/topic/performance/vitals/launch-time#warm)

## Public functions

### valueOf

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/benchmark#1.1.0)

```
fun valueOf(value: String): StartupMode
```

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 |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/benchmark#1.1.0)

```
fun values(): Array<StartupMode>
```

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.

## Public properties

### entries

```
val entries: EnumEntries<StartupMode>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.