KState/ca.acendas.kstate.core/StateContainer

StateContainer

Interface for managing immutable state with validation and thread safety.

StateContainer provides a controlled way to update immutable state objects while ensuring validation rules are enforced and operations are thread-safe.

Parameters

The type of state being managed

Inheritors

ImmutableStateContainer

EventDrivenStateContainer

ObservableStateContainer

ThreadSafeStateContainer

Properties

currentState

abstract val currentState: T

The current state of the container.

Functions

compareAndSet

fun <T> StateContainer<T>.compareAndSet(expectedState: T, newState: T): Boolean

Conditionally updates the state only if the current state matches the expected state.

getAndUpdate

fun <T> StateContainer<T>.getAndUpdate(updater: (T) -> T): T?

Updates the state and returns the previous state if successful, or null if failed.

getStateAs

inline fun <T, R : T> StateContainer<T>.getStateAs(): R?

Returns the current state cast to the specified type, or null if not of that type.

isState

fun <T> StateContainer<T>.isState(predicate: (T) -> Boolean): Boolean

Checks if the state matches a predicate.

isStateType

inline fun <T, R : T> StateContainer<T>.isStateType(): Boolean

Returns true if the current state is of the specified type.

map

fun <T, R> StateContainer<T>.map(mapper: (T) -> R): R

Maps the current state to a different type.

trySet

fun <T> StateContainer<T>.trySet(newState: T): Boolean

Attempts to set the state to a specific value.

updateAndGet

fun <T> StateContainer<T>.updateAndGet(updater: (T) -> T): T?

Updates the state and returns the new state if successful, or null if failed.

updateAtomic

fun <T> StateContainer<T>.updateAtomic(maxRetries: Int = 10, updater: (T) -> T): StateUpdateResult<T>

Extension function for StateContainer to perform atomic updates.

updateState

abstract fun updateState(updater: (T) -> T): StateUpdateResult<T>

Updates the state using the provided updater function.

updateSuspending

suspend fun <T> StateContainer<T>.updateSuspending(updater: suspend (T) -> T): StateUpdateResult<T>

Transforms the state using a suspending function while maintaining thread safety.

validateState

abstract fun validateState(state: T): ValidationResult

Validates the given state using the container's validator.

withState

fun <T> StateContainer<T>.withState(action: (T) -> Unit)

Executes an action with the current state.