KState/ca.acendas.kstate.dsl

Package-level declarations

Types

class ChangeWatcher<S, E : StateEvent>(builder: StateMachineBuilder<S, E>)

Wrapper for "watching changes" syntax.

EventTransitionBuilder

class EventTransitionBuilder<S, E : StateEvent, T : E>(scope: StateConversationalScope<S, E>, eventClass: KClass<T>)

Builder for event transitions with conversational syntax. Not an inner class to avoid type parameter shadowing.

InitialStateStarter

class InitialStateStarter<S, E : StateEvent>(builder: StateMachineBuilder<S, E>)

Wrapper class to enable "starting at State" syntax.

StateConversationalScope

class StateConversationalScope<S, E : StateEvent>(currentState: S)

Configuration scope for a specific state, providing conversational DSL.

TransitionWithSideEffect

class TransitionWithSideEffect<S, E : StateEvent>

Wrapper to add side effects after transition definition.

Properties

val <S, E : StateEvent> StateMachineBuilder<S, E>.starting: InitialStateStarter<S, E>

Starts the initial state configuration with "starting at State" syntax.

val <S, E : StateEvent> StateMachineBuilder<S, E>.watching: ChangeWatcher<S, E>

Starts observer configuration with "watching" keyword.

Functions

inline fun <S : Any, E : StateEvent> StateMachineBuilder<S, E>.during(state: S, configuration: StateConversationalScope<S, E>.() -> Unit)

Configures a state with conversational syntax: "during State { ... }"

infix fun <S, E : StateEvent> StateMachineBuilder<S, E>.initially(state: S)

Alternative syntax for setting initial state: "initially State"

onEveryTransition

fun <S, E : StateEvent> StateMachineBuilder<S, E>.onEveryTransition(effect: (oldState: S, newState: S) -> Unit)

Adds a global side effect that runs on every transition.

infix fun <S, E : StateEvent> StateMachineBuilder<S, E>.tracking(with: String): ((S, S) -> Unit) -> Unit

Adds an observer using "tracking with" syntax.

infix fun <S, E : StateEvent> StateMachineBuilder<S, E>.validateWith(validator: StateValidator<S>)

Sets the state validator directly.

infix fun <S, E : StateEvent> StateMachineBuilder<S, E>.validating(with: String): (StateValidator<S>) -> Unit

Sets the state validator with conversational syntax.