workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewEnvironmentKey

ViewEnvironmentKey

abstract class ViewEnvironmentKey<T : Any>(source)

Defines a value type T that can be provided by a ViewEnvironment map, and specifies its default value.

It is hard to imagine a useful implementation of this that is not a Kotlin object. Preferred use is to have the companion object of T extend this class. See BackStackConfig.Companion for an example.

Inheritors

Companion

Constructors

ViewEnvironmentKey

constructor()

Properties

default

abstract val default: T

Defines the default value for this key. It is a grievous error for this value to be dynamic in any way.

Functions

combine

open fun combine(left: T, right: T): T

Applied from ViewEnvironment.plus when the receiving environment already contains a value for this key. The default implementation replaces left with right.

equals

operator override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int