From a63a38be10badf0aa83fc5c0df9164bb2523307c Mon Sep 17 00:00:00 2001 From: Milos Marinkovic Date: Sat, 31 Oct 2020 12:33:28 +0100 Subject: [PATCH 1/3] Update front page docs & samples for release 1.1.0 --- README.md | 16 ++++------------ demo/build.gradle | 2 +- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3f86c1f..aa8c4c1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Simple State Machines in Kotlin (KSSM) -![Experimental State](https://img.shields.io/badge/state-experimental-orange) ![Workflow Status](https://img.shields.io/github/workflow/status/milosmns/kssm/Pre-release%20check) ![Code Size](https://img.shields.io/github/languages/code-size/milosmns/kssm) ![License](https://img.shields.io/github/license/milosmns/kssm) @@ -11,12 +10,11 @@ ## What is this? **KSSM** (reordered: _Kotlin - Simple State Machines_) provides an easy and simple DSL _(Domain Specific Language)_ for setting up [finite-state machines](https://en.wikipedia.org/wiki/Finite-state_machine), and opens a clean API with built-in threading and conflation mechanisms for manipulating states. -This library **does not** solve all state machine problems, **nor** does it address all possible use-cases related to state machines (although, it would like to). +This library **does not** solve all state machine problems, **nor** does it aim to address all possible use-cases related to state machines. It currently works only in the JVM environment. KSSM is based on the [Flow API](https://kotlinlang.org/docs/reference/coroutines/flow.html#flows) from Kotlin's coroutine package, more precisely on [State Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/). -State Flow is currently in `experimental` phase. This means that the API might be expanded in the future and is not safe for _inheritance_, but it is _safe for invocation/other use_. ## Quick Intro @@ -53,13 +51,7 @@ job.join() // or job.cancel(), or simply ignore ## Wiki -If you prefer longer documentation, check out the class documentation for -[StateMachine API](https://github.com/milosmns/kssm/blob/master/kssm/src/main/kotlin/me/angrybyte/kssm/api/StateMachine.kt). Actually, check it out anyway. -It's meant to be used in conjuction with the DSL, described in the -[DSL class docs](https://github.com/milosmns/kssm/blob/master/kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt). - -Website-like documentation is exported into [docs/dokka](https://github.com/milosmns/kssm/tree/master/docs/dokka/kssm) -directory, so you can also pull that directory to your computer and open `index.html`. +If you prefer longer documentation, check out the [longer version of the docs](https://milosmns.github.io/kssm/kssm/me.angrybyte.kssm.api). You want more? There are code samples [in the demo directory](https://github.com/milosmns/kssm/tree/master/demo/src/main/kotlin) that showcase the most interesting features of this library. @@ -70,7 +62,7 @@ It's hosted on JCenter and MavenCentral, and thus easy to depend upon with Gradl ```gradle dependencies { - // find the latest `$kssm_version` in a badge in this page's title + // find the latest `$kssm_version` on the top of this page implementation "me.angrybyte:kssm:$kssm_version" } ``` @@ -78,4 +70,4 @@ dependencies { ## Contributing & Code of Conduct Please open [a new issue](https://github.com/milosmns/kssm/issues/new) with any requests, issues, complaints or any other type of communication. -For sensitive or secure topics, don't hesitate to reach out to any of the maintainers directly. +For sensitive or security-related topics, don't hesitate to reach out to any maintainer directly. diff --git a/demo/build.gradle b/demo/build.gradle index 37bc509..f3333c0 100644 --- a/demo/build.gradle +++ b/demo/build.gradle @@ -14,7 +14,7 @@ dependencies { implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.0" - implementation "me.angrybyte:kssm:1.0.3" + implementation "me.angrybyte:kssm:1.1.0" } compileKotlin { From f8239087df886a1364583cc55fe5a2a503e55e22 Mon Sep 17 00:00:00 2001 From: Milos Marinkovic Date: Sat, 31 Oct 2020 12:48:57 +0100 Subject: [PATCH 2/3] Remove unnecessary experimental annotations --- demo/src/main/kotlin/Demo_Flow.kt | 2 -- demo/src/main/kotlin/Demo_Observers.kt | 2 -- demo/src/main/kotlin/Demo_Payloads.kt | 2 -- kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt | 3 --- .../kotlin/me/angrybyte/kssm/impl/machine/StateMachineImpl.kt | 2 -- .../me/angrybyte/kssm/impl/machine/StateMachineImplTest.kt | 2 +- 6 files changed, 1 insertion(+), 12 deletions(-) diff --git a/demo/src/main/kotlin/Demo_Flow.kt b/demo/src/main/kotlin/Demo_Flow.kt index 13e5e9b..d850f4d 100644 --- a/demo/src/main/kotlin/Demo_Flow.kt +++ b/demo/src/main/kotlin/Demo_Flow.kt @@ -8,7 +8,6 @@ import WaterState.Empty import WaterState.Ice import WaterState.Liquid import WaterState.Steam -import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.Job import kotlinx.coroutines.asCoroutineDispatcher import kotlinx.coroutines.flow.collect @@ -22,7 +21,6 @@ import me.angrybyte.kssm.dsl.stateMachine import me.angrybyte.kssm.dsl.to import java.util.concurrent.Executors -@ExperimentalCoroutinesApi fun main() = runBlocking { // NOTE: infix function 'to' comes from the DSL package diff --git a/demo/src/main/kotlin/Demo_Observers.kt b/demo/src/main/kotlin/Demo_Observers.kt index e61eab7..83f7ed1 100644 --- a/demo/src/main/kotlin/Demo_Observers.kt +++ b/demo/src/main/kotlin/Demo_Observers.kt @@ -8,7 +8,6 @@ import WaterState.Empty import WaterState.Ice import WaterState.Liquid import WaterState.Steam -import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.Job import kotlinx.coroutines.joinAll import kotlinx.coroutines.runBlocking @@ -18,7 +17,6 @@ import me.angrybyte.kssm.dsl.stateMachine import me.angrybyte.kssm.dsl.to import java.lang.System.err -@ExperimentalCoroutinesApi fun main() = runBlocking { // NOTE: infix function 'to' comes from the DSL package diff --git a/demo/src/main/kotlin/Demo_Payloads.kt b/demo/src/main/kotlin/Demo_Payloads.kt index 70f556b..80a4642 100644 --- a/demo/src/main/kotlin/Demo_Payloads.kt +++ b/demo/src/main/kotlin/Demo_Payloads.kt @@ -1,7 +1,6 @@ @file:Suppress("DuplicatedCode") import WaterState.Empty -import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.Job import kotlinx.coroutines.joinAll import kotlinx.coroutines.runBlocking @@ -16,7 +15,6 @@ import java.lang.System.err import java.util.concurrent.atomic.AtomicInteger @Suppress("UNCHECKED_CAST") -@ExperimentalCoroutinesApi fun main() = runBlocking { // NOTE: we can manipulate the payload as long as it's internally mutable diff --git a/kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt b/kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt index 2734ede..24d5bb5 100644 --- a/kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt +++ b/kssm/src/main/kotlin/me/angrybyte/kssm/dsl/StateMachineDsl.kt @@ -1,7 +1,6 @@ package me.angrybyte.kssm.dsl import kotlinx.coroutines.CoroutineDispatcher -import kotlinx.coroutines.ExperimentalCoroutinesApi import me.angrybyte.kssm.api.ErrorHandler import me.angrybyte.kssm.api.State import me.angrybyte.kssm.api.StateMachine @@ -127,12 +126,10 @@ class StateMachineDsl( /** * Starts the DSL ([StateMachineDsl]) with a configuration block on a new state machine instance. */ -@ExperimentalCoroutinesApi fun stateMachine(initialize: StateMachineDsl.() -> Unit): StateMachine = StateMachineDsl(StateMachineImpl()).apply(initialize).instance /** * Starts the DSL ([StateMachineDsl]) without a configuration block on a new state machine instance. */ -@ExperimentalCoroutinesApi fun stateMachine(): StateMachine = StateMachineImpl() \ No newline at end of file diff --git a/kssm/src/main/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImpl.kt b/kssm/src/main/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImpl.kt index c429e77..09deeef 100644 --- a/kssm/src/main/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImpl.kt +++ b/kssm/src/main/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImpl.kt @@ -4,7 +4,6 @@ import kotlinx.coroutines.CoroutineDispatcher import kotlinx.coroutines.CoroutineExceptionHandler import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.ExecutorCoroutineDispatcher -import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.Job import kotlinx.coroutines.SupervisorJob import kotlinx.coroutines.flow.Flow @@ -46,7 +45,6 @@ import me.angrybyte.kssm.impl.state.CoreState.None * } * ``` */ -@ExperimentalCoroutinesApi internal class StateMachineImpl : StateMachine, CoroutineScope { // Coroutine scope setup diff --git a/kssm/src/test/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImplTest.kt b/kssm/src/test/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImplTest.kt index 1da0eb1..6c8edd4 100644 --- a/kssm/src/test/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImplTest.kt +++ b/kssm/src/test/kotlin/me/angrybyte/kssm/impl/machine/StateMachineImplTest.kt @@ -31,7 +31,7 @@ import me.angrybyte.kssm.util.shouldThrow import org.junit.jupiter.api.AfterEach import org.junit.jupiter.api.Test -@ExperimentalCoroutinesApi +@ExperimentalCoroutinesApi // because of TestCoroutineDispatcher internal class StateMachineImplTest { companion object { From 614933857411162af01a73725fed469d6cca87f9 Mon Sep 17 00:00:00 2001 From: Milos Marinkovic Date: Sat, 31 Oct 2020 12:50:19 +0100 Subject: [PATCH 3/3] Update docs to reflect the latest changes --- docs/kssm/index.html | 22 +-- .../-incubation-exception/cause.html | 2 +- .../-incubation-exception/index.html | 80 +++++----- .../-incubation-exception/message.html | 2 +- .../-incubation-passed-exception.html | 2 +- .../-incubation-passed-exception/cause.html | 2 +- .../component1.html | 2 +- .../-incubation-passed-exception/copy.html | 2 +- .../-incubation-passed-exception/index.html | 96 ++++++------ .../-incubation-passed-exception/message.html | 2 +- .../operation.html | 2 +- .../-no-mapping-exception.html | 2 +- .../-no-mapping-exception/action.html | 2 +- .../-no-mapping-exception/cause.html | 2 +- .../-no-mapping-exception/component1.html | 2 +- .../-no-mapping-exception/component2.html | 2 +- .../-no-mapping-exception/copy.html | 2 +- .../-no-mapping-exception/index.html | 104 ++++++------- .../-no-mapping-exception/message.html | 2 +- .../-no-mapping-exception/state.html | 2 +- .../-state-mapping/-state-mapping.html | 2 +- .../-state-mapping/action.html | 2 +- .../-state-mapping/component1.html | 2 +- .../-state-mapping/component2.html | 2 +- .../-state-mapping/component3.html | 2 +- .../-state-mapping/copy.html | 2 +- .../-state-mapping/destination.html | 2 +- .../-state-mapping/index.html | 50 +++--- .../-state-mapping/source.html | 2 +- .../-state-mapping/to-string.html | 2 +- .../-transition/-transition.html | 2 +- .../-transition/action.html | 2 +- .../-transition/component1.html | 2 +- .../-transition/component2.html | 2 +- .../-transition/component3.html | 2 +- .../-transition/copy.html | 2 +- .../-transition/index.html | 50 +++--- .../-transition/new-state.html | 2 +- .../-transition/old-state.html | 2 +- .../-transition/to-string.html | 2 +- .../me.angrybyte.kssm.api.data/index.html | 40 ++--- .../require-payload.html | 2 +- .../me.angrybyte.kssm.api/-action/index.html | 44 +++--- .../me.angrybyte.kssm.api/-action/name.html | 2 +- .../-action/payload.html | 2 +- .../-state-machine/add-error-handler.html | 4 +- .../-state-machine/add-state-mapping.html | 2 +- .../add-transition-handler.html | 4 +- .../-state-machine/current-state.html | 2 +- .../-state-machine/errors.html | 2 +- .../-state-machine/finish.html | 2 +- .../-state-machine/get-all-actions.html | 2 +- .../-state-machine/get-all-states.html | 2 +- .../-state-machine/index.html | 142 +++++++++--------- .../-state-machine/last-action.html | 2 +- .../-state-machine/observe-errors.html | 2 +- .../-state-machine/observe-transitions.html | 2 +- .../-state-machine/remove-error-handler.html | 4 +- .../remove-transition-handler.html | 4 +- .../set-default-dispatcher.html | 2 +- .../set-error-handler-dispatcher.html | 2 +- .../-state-machine/set-initial-state.html | 2 +- .../set-strict-state-matching.html | 4 +- .../set-transition-handler-dispatcher.html | 2 +- .../-state-machine/transition.html | 2 +- .../-state-machine/transitions.html | 2 +- .../me.angrybyte.kssm.api/-state/index.html | 38 ++--- .../me.angrybyte.kssm.api/-state/name.html | 2 +- .../me.angrybyte.kssm.api/-state/payload.html | 2 +- docs/kssm/me.angrybyte.kssm.api/index.html | 36 ++--- .../-state-machine-dsl.html | 2 +- .../default-dispatcher.html | 2 +- .../-state-machine-dsl/error-handler.html | 4 +- .../-state-machine-dsl/errors-dispatcher.html | 2 +- .../-state-machine-dsl/index.html | 66 ++++---- .../-state-machine-dsl/initial-state.html | 2 +- .../-state-machine-dsl/mappings.html | 2 +- .../transition-handler.html | 4 +- .../transitions-dispatcher.html | 2 +- .../use-strict-matching.html | 2 +- .../-state-vector/-state-vector.html | 2 +- .../-state-vector/action.html | 2 +- .../-state-vector/component1.html | 2 +- .../-state-vector/component2.html | 2 +- .../-state-vector/copy.html | 2 +- .../-state-vector/index.html | 50 +++--- .../-state-vector/source.html | 2 +- docs/kssm/me.angrybyte.kssm.dsl/index.html | 62 ++++---- docs/kssm/me.angrybyte.kssm.dsl/moves.html | 2 +- .../me.angrybyte.kssm.dsl/named-action.html | 2 +- .../me.angrybyte.kssm.dsl/named-state.html | 2 +- .../me.angrybyte.kssm.dsl/payload-action.html | 2 +- .../me.angrybyte.kssm.dsl/payload-state.html | 2 +- .../me.angrybyte.kssm.dsl/state-machine.html | 6 +- docs/kssm/me.angrybyte.kssm.dsl/to.html | 2 +- .../-singleton-action/-singleton-action.html | 2 +- .../-singleton-action/index.html | 30 ++-- .../-singleton-action/name.html | 2 +- .../-singleton-action/payload.html | 2 +- .../-singleton-action/to-string.html | 2 +- .../me.angrybyte.kssm.impl.action/index.html | 8 +- .../-singleton-state/-singleton-state.html | 2 +- .../-singleton-state/index.html | 30 ++-- .../-singleton-state/name.html | 2 +- .../-singleton-state/payload.html | 2 +- .../-singleton-state/to-string.html | 2 +- .../me.angrybyte.kssm.impl.state/index.html | 8 +- docs/navigation.html | 52 +++---- 108 files changed, 602 insertions(+), 602 deletions(-) diff --git a/docs/kssm/index.html b/docs/kssm/index.html index e443ab9..ba0af43 100644 --- a/docs/kssm/index.html +++ b/docs/kssm/index.html @@ -26,17 +26,17 @@ -
+
kssm

kssm

Packages

-
+
-
me.angrybyte.kssm.api +
me.angrybyte.kssm.api @@ -49,11 +49,11 @@

Packages

- +
- - +
-
me.angrybyte.kssm.dsl +
me.angrybyte.kssm.dsl @@ -83,11 +83,11 @@

Packages

- +
- - +
-
me.angrybyte.kssm.impl.state +
me.angrybyte.kssm.impl.state diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/cause.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/cause.html index 80d962f..1ff9c80 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/cause.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/cause.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationException/cause

cause

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/index.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/index.html index 8f55d5a..b354bcb 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationException

IncubationException

@@ -40,10 +40,10 @@

IncubationException

Functions

-
+
-
addSuppressed +
addSuppressed @@ -55,7 +55,7 @@

Functions

-
fun addSuppressed(p0: Throwable) +
fun addSuppressed(p0: Throwable)
@@ -66,10 +66,10 @@

Functions

- +
-
equals +
equals @@ -81,7 +81,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -92,10 +92,10 @@

Functions

- +
-
fillInStackTrace +
fillInStackTrace @@ -107,7 +107,7 @@

Functions

-
open fun fillInStackTrace(): Throwable +
open fun fillInStackTrace(): Throwable
@@ -118,10 +118,10 @@

Functions

- +
-
getLocalizedMessage +
getLocalizedMessage @@ -133,7 +133,7 @@

Functions

-
open fun getLocalizedMessage(): String +
open fun getLocalizedMessage(): String
@@ -144,10 +144,10 @@

Functions

- +
-
getStackTrace +
getStackTrace @@ -159,7 +159,7 @@

Functions

-
open fun getStackTrace(): Array<StackTraceElement> +
open fun getStackTrace(): Array<StackTraceElement>
@@ -170,10 +170,10 @@

Functions

- +
-
getSuppressed +
getSuppressed @@ -185,7 +185,7 @@

Functions

-
fun getSuppressed(): Array<Throwable> +
fun getSuppressed(): Array<Throwable>
@@ -196,10 +196,10 @@

Functions

- +
-
hashCode +
hashCode @@ -211,7 +211,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -222,10 +222,10 @@

Functions

- +
-
initCause +
initCause @@ -237,7 +237,7 @@

Functions

-
open fun initCause(p0: Throwable): Throwable +
open fun initCause(p0: Throwable): Throwable
@@ -248,10 +248,10 @@

Functions

- +
-
printStackTrace +
printStackTrace @@ -263,15 +263,15 @@

Functions

-
open fun printStackTrace() +
open fun printStackTrace()
-Content copied to clipboard
open fun printStackTrace(p0: PrintStream) +Content copied to clipboard
open fun printStackTrace(p0: PrintStream)
-Content copied to clipboard
open fun printStackTrace(p0: PrintWriter) +Content copied to clipboard
open fun printStackTrace(p0: PrintWriter)
@@ -282,10 +282,10 @@

Functions

- +
-
setStackTrace +
setStackTrace @@ -297,7 +297,7 @@

Functions

-
open fun setStackTrace(p0: Array<StackTraceElement>) +
open fun setStackTrace(p0: Array<StackTraceElement>)
@@ -308,10 +308,10 @@

Functions

- +
-
toString +
toString @@ -323,7 +323,7 @@

Functions

-
open fun toString(): String +
open fun toString(): String
@@ -336,10 +336,10 @@

Functions

Properties

-
+
-
cause +
cause @@ -358,10 +358,10 @@

Properties

- +
-
message +
message diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/message.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/message.html index c450370..fc66541 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/message.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-exception/message.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationException/message

message

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/-incubation-passed-exception.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/-incubation-passed-exception.html index d173658..f5ad889 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/-incubation-passed-exception.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/-incubation-passed-exception.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/IncubationPassedException

IncubationPassedException

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/cause.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/cause.html index 268e152..1f7ca04 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/cause.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/cause.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/cause

cause

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/component1.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/component1.html index f33b271..20072c1 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/component1.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/component1.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/component1

component1

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/copy.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/copy.html index d1b6b3d..7e7e7c9 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/copy.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/copy.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/copy

copy

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/index.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/index.html index a0e3706..acbcb72 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException

IncubationPassedException

@@ -40,10 +40,10 @@

IncubationPassed

Constructors

-
+
-
IncubationPassedException +
IncubationPassedException @@ -64,10 +64,10 @@

Constructors

Functions

-
+
-
addSuppressed +
addSuppressed @@ -79,7 +79,7 @@

Functions

-
fun addSuppressed(p0: Throwable) +
fun addSuppressed(p0: Throwable)
@@ -90,10 +90,10 @@

Functions

- +
-
component1 +
component1 @@ -116,10 +116,10 @@

Functions

- +
-
copy +
copy @@ -142,10 +142,10 @@

Functions

- +
-
equals +
equals @@ -157,7 +157,7 @@

Functions

-
open operator override fun equals(other: Any?): Boolean +
open operator override fun equals(other: Any?): Boolean
@@ -168,10 +168,10 @@

Functions

- +
-
fillInStackTrace +
fillInStackTrace @@ -183,7 +183,7 @@

Functions

-
open fun fillInStackTrace(): Throwable +
open fun fillInStackTrace(): Throwable
@@ -194,10 +194,10 @@

Functions

- +
-
getLocalizedMessage +
getLocalizedMessage @@ -209,7 +209,7 @@

Functions

-
open fun getLocalizedMessage(): String +
open fun getLocalizedMessage(): String
@@ -220,10 +220,10 @@

Functions

- +
-
getStackTrace +
getStackTrace @@ -235,7 +235,7 @@

Functions

-
open fun getStackTrace(): Array<StackTraceElement> +
open fun getStackTrace(): Array<StackTraceElement>
@@ -246,10 +246,10 @@

Functions

- +
-
getSuppressed +
getSuppressed @@ -261,7 +261,7 @@

Functions

-
fun getSuppressed(): Array<Throwable> +
fun getSuppressed(): Array<Throwable>
@@ -272,10 +272,10 @@

Functions

- +
-
hashCode +
hashCode @@ -287,7 +287,7 @@

Functions

-
open override fun hashCode(): Int +
open override fun hashCode(): Int
@@ -298,10 +298,10 @@

Functions

- +
-
initCause +
initCause @@ -313,7 +313,7 @@

Functions

-
open fun initCause(p0: Throwable): Throwable +
open fun initCause(p0: Throwable): Throwable
@@ -324,10 +324,10 @@

Functions

- +
-
printStackTrace +
printStackTrace @@ -339,15 +339,15 @@

Functions

-
open fun printStackTrace() +
open fun printStackTrace()
-Content copied to clipboard
open fun printStackTrace(p0: PrintStream) +Content copied to clipboard
open fun printStackTrace(p0: PrintStream)
-Content copied to clipboard
open fun printStackTrace(p0: PrintWriter) +Content copied to clipboard
open fun printStackTrace(p0: PrintWriter)
@@ -358,10 +358,10 @@

Functions

- +
-
setStackTrace +
setStackTrace @@ -373,7 +373,7 @@

Functions

-
open fun setStackTrace(p0: Array<StackTraceElement>) +
open fun setStackTrace(p0: Array<StackTraceElement>)
@@ -384,10 +384,10 @@

Functions

- +
-
toString +
toString @@ -399,7 +399,7 @@

Functions

-
open override fun toString(): String +
open override fun toString(): String
@@ -412,10 +412,10 @@

Functions

Properties

-
+
-
cause +
cause @@ -434,10 +434,10 @@

Properties

- +
-
message +
message @@ -456,10 +456,10 @@

Properties

- +
-
operation +
operation diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/message.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/message.html index 0e1e69e..3149543 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/message.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/message.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/message

message

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/operation.html b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/operation.html index 08337c8..230cbde 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/operation.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-incubation-passed-exception/operation.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/IncubationPassedException/operation

operation

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/-no-mapping-exception.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/-no-mapping-exception.html index 2401249..58b0a52 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/-no-mapping-exception.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/-no-mapping-exception.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/NoMappingException

NoMappingException

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/action.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/action.html index 5917e5e..9d7a192 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/action.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/action

action

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/cause.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/cause.html index 5743cdb..2ae8df2 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/cause.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/cause.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/cause

cause

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component1.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component1.html index d38a795..4cfb4e8 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component1.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component1.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/component1

component1

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component2.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component2.html index 478b9af..dbfad01 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component2.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/component2.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/component2

component2

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/copy.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/copy.html index 4fa2455..a9a572b 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/copy.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/copy.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/copy

copy

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/index.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/index.html index 1cf814c..71af717 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException

NoMappingException

@@ -40,10 +40,10 @@

NoMapping

Constructors

-
+
-
NoMappingException +
NoMappingException @@ -64,10 +64,10 @@

Constructors

Functions

-
+
-
addSuppressed +
addSuppressed @@ -79,7 +79,7 @@

Functions

-
fun addSuppressed(p0: Throwable) +
fun addSuppressed(p0: Throwable)
@@ -90,10 +90,10 @@

Functions

- +
-
component1 +
component1 @@ -116,10 +116,10 @@

Functions

- +
-
component2 +
component2 @@ -142,10 +142,10 @@

Functions

- +
-
copy +
copy @@ -168,10 +168,10 @@

Functions

- +
-
equals +
equals @@ -183,7 +183,7 @@

Functions

-
open operator override fun equals(other: Any?): Boolean +
open operator override fun equals(other: Any?): Boolean
@@ -194,10 +194,10 @@

Functions

- +
-
fillInStackTrace +
fillInStackTrace @@ -209,7 +209,7 @@

Functions

-
open fun fillInStackTrace(): Throwable +
open fun fillInStackTrace(): Throwable
@@ -220,10 +220,10 @@

Functions

- +
-
getLocalizedMessage +
getLocalizedMessage @@ -235,7 +235,7 @@

Functions

-
open fun getLocalizedMessage(): String +
open fun getLocalizedMessage(): String
@@ -246,10 +246,10 @@

Functions

- +
-
getStackTrace +
getStackTrace @@ -261,7 +261,7 @@

Functions

-
open fun getStackTrace(): Array<StackTraceElement> +
open fun getStackTrace(): Array<StackTraceElement>
@@ -272,10 +272,10 @@

Functions

- +
-
getSuppressed +
getSuppressed @@ -287,7 +287,7 @@

Functions

-
fun getSuppressed(): Array<Throwable> +
fun getSuppressed(): Array<Throwable>
@@ -298,10 +298,10 @@

Functions

- +
-
hashCode +
hashCode @@ -313,7 +313,7 @@

Functions

-
open override fun hashCode(): Int +
open override fun hashCode(): Int
@@ -324,10 +324,10 @@

Functions

- +
-
initCause +
initCause @@ -339,7 +339,7 @@

Functions

-
open fun initCause(p0: Throwable): Throwable +
open fun initCause(p0: Throwable): Throwable
@@ -350,10 +350,10 @@

Functions

- +
-
printStackTrace +
printStackTrace @@ -365,15 +365,15 @@

Functions

-
open fun printStackTrace() +
open fun printStackTrace()
-Content copied to clipboard
open fun printStackTrace(p0: PrintStream) +Content copied to clipboard
open fun printStackTrace(p0: PrintStream)
-Content copied to clipboard
open fun printStackTrace(p0: PrintWriter) +Content copied to clipboard
open fun printStackTrace(p0: PrintWriter)
@@ -384,10 +384,10 @@

Functions

- +
-
setStackTrace +
setStackTrace @@ -399,7 +399,7 @@

Functions

-
open fun setStackTrace(p0: Array<StackTraceElement>) +
open fun setStackTrace(p0: Array<StackTraceElement>)
@@ -410,10 +410,10 @@

Functions

- +
-
toString +
toString @@ -425,7 +425,7 @@

Functions

-
open override fun toString(): String +
open override fun toString(): String
@@ -438,10 +438,10 @@

Functions

Properties

-
+
-
action +
action @@ -460,10 +460,10 @@

Properties

- +
-
cause +
cause @@ -482,10 +482,10 @@

Properties

- +
-
message +
message @@ -504,10 +504,10 @@

Properties

- +
-
state +
state diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/message.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/message.html index a8180fa..4c07aab 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/message.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/message.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/message

message

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/state.html b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/state.html index ffa057d..3da65ac 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/state.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-no-mapping-exception/state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/NoMappingException/state

state

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/-state-mapping.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/-state-mapping.html index 0ea2be8..23056ef 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/-state-mapping.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/-state-mapping.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/StateMapping

StateMapping

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/action.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/action.html index f9a7791..dbfb81c 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/action.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/action

action

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component1.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component1.html index 0404777..1ad1743 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component1.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component1.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/component1

component1

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component2.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component2.html index 26f12f2..401b9da 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component2.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component2.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/component2

component2

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component3.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component3.html index ffba09c..5973e08 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component3.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/component3.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/component3

component3

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/copy.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/copy.html index 9715280..eed7db0 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/copy.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/copy.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/copy

copy

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/destination.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/destination.html index 41df81e..987bbd0 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/destination.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/destination.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/destination

destination

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/index.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/index.html index c36664c..8263cda 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping

StateMapping

@@ -48,10 +48,10 @@

Parameters

A

action's payload type

action

the trigger/action (what makes the transition start)

D

destination state's payload type

destination

the goal state (where the transition would end at)

S

source state's payload type

source

the origin state (where the transition would start from)

Constructors

-
+
-
StateMapping +
StateMapping @@ -72,10 +72,10 @@

Constructors

Functions

-
+
-
component1 +
component1 @@ -98,10 +98,10 @@

Functions

- +
-
component2 +
component2 @@ -124,10 +124,10 @@

Functions

- +
-
component3 +
component3 @@ -150,10 +150,10 @@

Functions

- +
-
copy +
copy @@ -176,10 +176,10 @@

Functions

- +
-
equals +
equals @@ -191,7 +191,7 @@

Functions

-
open operator override fun equals(other: Any?): Boolean +
open operator override fun equals(other: Any?): Boolean
@@ -202,10 +202,10 @@

Functions

- +
-
hashCode +
hashCode @@ -217,7 +217,7 @@

Functions

-
open override fun hashCode(): Int +
open override fun hashCode(): Int
@@ -228,10 +228,10 @@

Functions

- +
-
toString +
toString @@ -256,10 +256,10 @@

Functions

Properties

-
+
-
action +
action @@ -278,10 +278,10 @@

Properties

- +
-
destination +
destination @@ -300,10 +300,10 @@

Properties

- +
-
source +
source diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/source.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/source.html index d400e8a..a4a108a 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/source.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/source.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/source

source

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/to-string.html b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/to-string.html index f00b1c9..0fa2591 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/to-string.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-state-mapping/to-string.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/StateMapping/toString

toString

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/-transition.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/-transition.html index f098f48..3ef5e20 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/-transition.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/-transition.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/Transition

Transition

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/action.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/action.html index 70e0f9f..8c4ca97 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/action.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/action

action

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component1.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component1.html index 451ceea..cce7be3 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component1.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component1.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/component1

component1

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component2.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component2.html index 3ad36d0..be06acc 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component2.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component2.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/component2

component2

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component3.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component3.html index 0c0f419..4621daf 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/component3.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/component3.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/component3

component3

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/copy.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/copy.html index cf998c0..771b5db 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/copy.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/copy.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/copy

copy

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/index.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/index.html index 0951078..5611e2a 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition

Transition

@@ -48,10 +48,10 @@

Parameters

A

the action's payload type

action

the action that triggered the state transition

D

the new state's payload type

newState

the state to which the StateMachine transitioned

oldState

the state from which the StateMachine transitioned

S

the old state's payload type

Constructors

-
+
-
Transition +
Transition @@ -72,10 +72,10 @@

Constructors

Functions

-
+
-
component1 +
component1 @@ -98,10 +98,10 @@

Functions

- +
-
component2 +
component2 @@ -124,10 +124,10 @@

Functions

- +
-
component3 +
component3 @@ -150,10 +150,10 @@

Functions

- +
-
copy +
copy @@ -176,10 +176,10 @@

Functions

- +
-
equals +
equals @@ -191,7 +191,7 @@

Functions

-
open operator override fun equals(other: Any?): Boolean +
open operator override fun equals(other: Any?): Boolean
@@ -202,10 +202,10 @@

Functions

- +
-
hashCode +
hashCode @@ -217,7 +217,7 @@

Functions

-
open override fun hashCode(): Int +
open override fun hashCode(): Int
@@ -228,10 +228,10 @@

Functions

- +
-
toString +
toString @@ -256,10 +256,10 @@

Functions

Properties

-
+
-
action +
action @@ -278,10 +278,10 @@

Properties

- +
-
newState +
newState @@ -300,10 +300,10 @@

Properties

- +
-
oldState +
oldState diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/new-state.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/new-state.html index 80c74a0..58e881c 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/new-state.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/new-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/newState

newState

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/old-state.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/old-state.html index 7b86886..efc869f 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/old-state.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/old-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/oldState

oldState

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/-transition/to-string.html b/docs/kssm/me.angrybyte.kssm.api.data/-transition/to-string.html index fd52d4a..b9855e9 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/-transition/to-string.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/-transition/to-string.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/Transition/toString

toString

diff --git a/docs/kssm/me.angrybyte.kssm.api.data/index.html b/docs/kssm/me.angrybyte.kssm.api.data/index.html index 0bd4439..3b00458 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/index.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data

Package me.angrybyte.kssm.api.data

@@ -35,10 +35,10 @@

Package me.angrybyte.

Types

-
+
-
IncubationException +
IncubationException @@ -56,15 +56,15 @@

Types

Content copied to clipboard
-
Signals the catcher that StateMachine is in incubation state.
+
Signals the catcher that StateMachine is in incubation state.
- +
-
IncubationPassedException +
IncubationPassedException @@ -82,15 +82,15 @@

Types

Content copied to clipboard
-
Signals the catcher that StateMachine has passed the incubation state.
+
Signals the catcher that StateMachine has passed the incubation state.
- +
-
NoMappingException +
NoMappingException @@ -108,15 +108,15 @@

Types

Content copied to clipboard
-
Signals the catcher that StateMachine doesn't have the mapping registered for the given state and action.
+
Signals the catcher that StateMachine doesn't have the mapping registered for the given state and action.
- +
-
StateMapping +
StateMapping @@ -134,15 +134,15 @@

Types

Content copied to clipboard
-
Keeps information about a particular state-to-state transition mapping.
+
Keeps information about a particular state-to-state transition mapping.
- +
-
Transition +
Transition @@ -160,17 +160,17 @@

Types

Content copied to clipboard
-
In most ways a structurally similar data model to StateMapping.
+
In most ways a structurally similar data model to StateMapping.

Functions

-
+
-
requirePayload +
requirePayload @@ -188,7 +188,7 @@

Functions

Content copied to clipboard
-
Force casts the payload object into a non-null value of type T and returns it.
+
Force casts the payload object into a non-null value of type T and returns it.
@@ -198,7 +198,7 @@

Functions

Content copied to clipboard
-
Force casts the payload object into a non-null value of type T and returns it.
+
Force casts the payload object into a non-null value of type T and returns it.
diff --git a/docs/kssm/me.angrybyte.kssm.api.data/require-payload.html b/docs/kssm/me.angrybyte.kssm.api.data/require-payload.html index 98966a2..b49484c 100644 --- a/docs/kssm/me.angrybyte.kssm.api.data/require-payload.html +++ b/docs/kssm/me.angrybyte.kssm.api.data/require-payload.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api.data/requirePayload

requirePayload

diff --git a/docs/kssm/me.angrybyte.kssm.api/-action/index.html b/docs/kssm/me.angrybyte.kssm.api/-action/index.html index 1011354..72a1124 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-action/index.html +++ b/docs/kssm/me.angrybyte.kssm.api/-action/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/Action

Action

@@ -48,10 +48,10 @@

Parameters

T

the action's payload type

Functions

-
+
-
equals +
equals @@ -63,7 +63,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -74,10 +74,10 @@

Functions

- +
-
hashCode +
hashCode @@ -89,7 +89,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -100,10 +100,10 @@

Functions

- +
-
toString +
toString @@ -115,7 +115,7 @@

Functions

-
open fun toString(): String +
open fun toString(): String
@@ -128,10 +128,10 @@

Functions

Properties

-
+
-
name +
name @@ -150,10 +150,10 @@

Properties

- +
-
payload +
payload @@ -174,10 +174,10 @@

Properties

Inheritors

-
+
-
SingletonAction +
SingletonAction @@ -190,10 +190,10 @@

Inheritors

Extensions

-
+
-
moves +
moves @@ -211,15 +211,15 @@

Extensions

Content copied to clipboard
-
Binds an Action and a source State into a StateVector.
+
Binds an Action and a source State into a StateVector.
- +
-
requirePayload +
requirePayload @@ -237,7 +237,7 @@

Extensions

Content copied to clipboard
-
Force casts the payload object into a non-null value of type T and returns it.
+
Force casts the payload object into a non-null value of type T and returns it.
diff --git a/docs/kssm/me.angrybyte.kssm.api/-action/name.html b/docs/kssm/me.angrybyte.kssm.api/-action/name.html index 494a14a..0c5f396 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-action/name.html +++ b/docs/kssm/me.angrybyte.kssm.api/-action/name.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/Action/name

name

diff --git a/docs/kssm/me.angrybyte.kssm.api/-action/payload.html b/docs/kssm/me.angrybyte.kssm.api/-action/payload.html index f9a4c12..44fa9ea 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-action/payload.html +++ b/docs/kssm/me.angrybyte.kssm.api/-action/payload.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/Action/payload

payload

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-error-handler.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-error-handler.html index 0639ca3..46b6028 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-error-handler.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-error-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/addErrorHandler

addErrorHandler

@@ -34,7 +34,7 @@

addError
-
abstract fun addErrorHandler(handler: ErrorHandler) +
abstract fun addErrorHandler(handler: ErrorHandler)
diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-state-mapping.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-state-mapping.html index fd6c6a9..19154f4 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-state-mapping.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-state-mapping.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/addStateMapping

addStateMapping

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-transition-handler.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-transition-handler.html index c00193b..105108f 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-transition-handler.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/add-transition-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/addTransitionHandler

addTransitionHandler

@@ -34,7 +34,7 @@

addTransition<
-
abstract fun addTransitionHandler(handler: TransitionHandler) +
abstract fun addTransitionHandler(handler: TransitionHandler)
diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/current-state.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/current-state.html index e071213..dd35c37 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/current-state.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/current-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/currentState

currentState

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/errors.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/errors.html index 32f55ec..3dac510 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/errors.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/errors.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/errors

errors

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/finish.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/finish.html index f1b4abd..8255851 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/finish.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/finish.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/finish

finish

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-actions.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-actions.html index dd4850c..3866224 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-actions.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-actions.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/getAllActions

getAllActions

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-states.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-states.html index 97e5fc0..2c6f499 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-states.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/get-all-states.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/getAllStates

getAllStates

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/index.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/index.html index 1481a45..bf8670d 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/index.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine

StateMachine

@@ -34,7 +34,7 @@

StateMachine

-Content copied to clipboard

The public-facing API for configuring, using and observing changes within a finite state machine.

About state machines

Fundamentally, a finite state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to some inputs (called actions here), and the change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the inputs/actions that trigger each of the transitions. In the context of this API, these definitions are called "state mappings".

A state is a description of the status of a system that is waiting to execute a transition. A transition can be one, or a set of actions, to be executed when a condition is fulfilled or when an event is received. For example, when using an audio system to listen to the radio (the system is in the "playing radio" state), receiving a "next" action results in moving to the next station. When the system is in the "playing CD" state, the "next" stimulus results in moving to the next track. Identical stimuli trigger different actions depending on the current state.

See this image for a quick reference.

Source: Wikipedia

Containment

This particular API assumes that the state machine is self-contained. This means that all processing and state manipulation happens inside of the implementing class: outside observers and interactors can only use a reduced set of state machine touch-points that this API exposes.

All possible states and actions should be configured before any transition is executed.

Threading

By default, a single-threaded, queue-like event loop will be created for processing events and reporting results and errors. This event loop belongs to a CoroutineDispatcher that gets created before the state machine starts running. In case you want to change threads, make sure that your dispatcher is single-threaded - otherwise you'll get the reported events out of order. The API exposes functions for changing the dispatchers in 3 layers:

  • Default dispatcher: used for internal processing of actions and transitioning to new states

  • Transitions dispatcher: used for reporting state changes

  • Error dispatcher: used for reporting any issues that occur while processing events

The state machine manages its internal running jobs and transitions in a thread-safe way, while exposing control over long-running tasks to the user when needed by returning a Job object for monitoring.

Monitoring

The state machine can be monitored in a couple of ways:

  • Flow: (preferred) allows data manipulation and in-place concurrency using the familiar native interface

  • Handlers: TransitionHandler and ErrorHandler allow suspending reactions to state machine events

  • Observers: caller supplies a callback lambda, and gets a Job in response to cancel the processing manually

Note that for handlers and suspending jobs, state machine runs processing actions on configured dispatchers. The recommended approach with Flow allows you to control your own processing mechanism, e.g. in a nested coroutine.

Instantiating

Trying to instantiate these state machines manually using constructors is an error. To be sure that things are correctly configured and prepared for executing event transitions, use the StateMachineDsl.

Here's an example how that would look like:

object AtoB : SingletonAction()
object BtoC : SingletonAction()
object CtoC : SingletonAction()
object A : SingletonState()
object B : SingletonState()
object C : SingletonState()

val sm = stateMachine {
  mappings(
    AtoB moves A to B,
    BtoC moves B to C,
    CtoC moves C to C
  )

  defaultDispatcher = findMyProcessingDispatcher() // optional
  transitionsDispatcher = findMyTransitionsDispatcher() // optional

  transitionHandler { /* inline handler */}

  initialState = A
}

The returned object is an instance of this interface and you can call API functions on it. The returned instance is thread-safe, so you can multi-thread on it without any issues.

+Content copied to clipboard

The public-facing API for configuring, using and observing changes within a finite state machine.

About state machines

Fundamentally, a finite state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to some inputs (called actions here), and the change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the inputs/actions that trigger each of the transitions. In the context of this API, these definitions are called "state mappings".

A state is a description of the status of a system that is waiting to execute a transition. A transition can be one, or a set of actions, to be executed when a condition is fulfilled or when an event is received. For example, when using an audio system to listen to the radio (the system is in the "playing radio" state), receiving a "next" action results in moving to the next station. When the system is in the "playing CD" state, the "next" stimulus results in moving to the next track. Identical stimuli trigger different actions depending on the current state.

See this image for a quick reference.

Source: Wikipedia

Containment

This particular API assumes that the state machine is self-contained. This means that all processing and state manipulation happens inside of the implementing class: outside observers and interactors can only use a reduced set of state machine touch-points that this API exposes.

All possible states and actions should be configured before any transition is executed.

Threading

By default, a single-threaded, queue-like event loop will be created for processing events and reporting results and errors. This event loop belongs to a CoroutineDispatcher that gets created before the state machine starts running. In case you want to change threads, make sure that your dispatcher is single-threaded - otherwise you'll get the reported events out of order. The API exposes functions for changing the dispatchers in 3 layers:

  • Default dispatcher: used for internal processing of actions and transitioning to new states

  • Transitions dispatcher: used for reporting state changes

  • Error dispatcher: used for reporting any issues that occur while processing events

The state machine manages its internal running jobs and transitions in a thread-safe way, while exposing control over long-running tasks to the user when needed by returning a Job object for monitoring.

Monitoring

The state machine can be monitored in a couple of ways:

  • Flow: (preferred) allows data manipulation and in-place concurrency using the familiar native interface

  • Handlers: TransitionHandler and ErrorHandler allow suspending reactions to state machine events

  • Observers: caller supplies a callback lambda, and gets a Job in response to cancel the processing manually

Note that for handlers and suspending jobs, state machine runs processing actions on configured dispatchers. The recommended approach with Flow allows you to control your own processing mechanism, e.g. in a nested coroutine.

Instantiating

Trying to instantiate these state machines manually using constructors is an error. To be sure that things are correctly configured and prepared for executing event transitions, use the StateMachineDsl.

Here's an example how that would look like:

object AtoB : SingletonAction()
object BtoC : SingletonAction()
object CtoC : SingletonAction()
object A : SingletonState()
object B : SingletonState()
object C : SingletonState()

val sm = stateMachine {
  mappings(
    AtoB moves A to B,
    BtoC moves B to C,
    CtoC moves C to C
  )

  defaultDispatcher = findMyProcessingDispatcher() // optional
  transitionsDispatcher = findMyTransitionsDispatcher() // optional

  transitionHandler { /* inline handler */}

  initialState = A
}

The returned object is an instance of this interface and you can call API functions on it. The returned instance is thread-safe, so you can multi-thread on it without any issues.

@@ -44,10 +44,10 @@

See also

Functions

-
+
-
addErrorHandler +
addErrorHandler @@ -59,21 +59,21 @@

Functions

-
abstract fun addErrorHandler(handler: ErrorHandler) +
abstract fun addErrorHandler(handler: ErrorHandler)
Content copied to clipboard
-
Adds a suspending error handler that gets invoked every time an error needs to be reported.
+
Adds a suspending error handler that gets invoked every time an error needs to be reported.
- +
-
addStateMapping +
addStateMapping @@ -91,15 +91,15 @@

Functions

Content copied to clipboard
-
Manually add new StateMappings to this state machine.
+
Manually add new StateMappings to this state machine.
- +
-
addTransitionHandler +
addTransitionHandler @@ -111,21 +111,21 @@

Functions

-
abstract fun addTransitionHandler(handler: TransitionHandler) +
abstract fun addTransitionHandler(handler: TransitionHandler)
Content copied to clipboard
-
Adds a suspending transition handler that gets invoked every time a transition change needs to be reported.
+
Adds a suspending transition handler that gets invoked every time a transition change needs to be reported.
- +
-
equals +
equals @@ -137,7 +137,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -148,10 +148,10 @@

Functions

- +
-
finish +
finish @@ -169,15 +169,15 @@

Functions

Content copied to clipboard
-
Stops all internal processing and removes all transition and error handlers and observables.
+
Stops all internal processing and removes all transition and error handlers and observables.
- +
-
getAllActions +
getAllActions @@ -195,15 +195,15 @@

Functions

Content copied to clipboard
-
Diagnostics: Check all possible actions this state machine can process
+
Diagnostics: Check all possible actions this state machine can process
- +
-
getAllStates +
getAllStates @@ -221,15 +221,15 @@

Functions

Content copied to clipboard
-
Diagnostics: Check all possible states this state machine can transition to
+
Diagnostics: Check all possible states this state machine can transition to
- +
-
hashCode +
hashCode @@ -241,7 +241,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -252,10 +252,10 @@

Functions

- +
-
observeErrors +
observeErrors @@ -273,15 +273,15 @@

Functions

Content copied to clipboard
-
Allows observing error changes using a plain callback lambda.
+
Allows observing error changes using a plain callback lambda.
- +
-
observeTransitions +
observeTransitions @@ -299,15 +299,15 @@

Functions

Content copied to clipboard
-
Allows observing transition changes using a plain callback lambda.
+
Allows observing transition changes using a plain callback lambda.
- +
-
removeErrorHandler +
removeErrorHandler @@ -319,21 +319,21 @@

Functions

-
abstract fun removeErrorHandler(handler: ErrorHandler) +
abstract fun removeErrorHandler(handler: ErrorHandler)
Content copied to clipboard
-
Inverse to addErrorHandler.
+
Inverse to addErrorHandler.
- +
-
removeTransitionHandler +
removeTransitionHandler @@ -345,21 +345,21 @@

Functions

-
abstract fun removeTransitionHandler(handler: TransitionHandler) +
abstract fun removeTransitionHandler(handler: TransitionHandler)
Content copied to clipboard
-
Inverse to addTransitionHandler.
+
Inverse to addTransitionHandler.
- +
-
setDefaultDispatcher +
setDefaultDispatcher @@ -377,15 +377,15 @@

Functions

Content copied to clipboard
-
Changes the dispatcher that internally processes state machine changes.
+
Changes the dispatcher that internally processes state machine changes.
- +
-
setErrorHandlerDispatcher +
setErrorHandlerDispatcher @@ -403,15 +403,15 @@

Functions

Content copied to clipboard
-
Changes the dispatcher that reports errors.
+
Changes the dispatcher that reports errors.

- +
-
setInitialState +
setInitialState @@ -429,15 +429,15 @@

Functions

Content copied to clipboard
-
Sets the initial state for this state machine.
+
Sets the initial state for this state machine.
- +
-
setStrictStateMatching +
setStrictStateMatching @@ -455,15 +455,15 @@

Functions

Content copied to clipboard
-
Allows the caller to switch between strict and loose state matching modes.
+
Allows the caller to switch between strict and loose state matching modes.
- +
-
setTransitionHandlerDispatcher +
setTransitionHandlerDispatcher @@ -481,15 +481,15 @@

Functions

Content copied to clipboard

-
Changes the dispatcher that reports transition changes.
+
Changes the dispatcher that reports transition changes.
- +
-
toString +
toString @@ -501,7 +501,7 @@

Functions

-
open fun toString(): String +
open fun toString(): String
@@ -512,10 +512,10 @@

Functions

- +
-
transition +
transition @@ -533,17 +533,17 @@

Functions

Content copied to clipboard
-
Attempts to transition the state machine into a new State using the given Action.
+
Attempts to transition the state machine into a new State using the given Action.

Properties

-
+
-
currentState +
currentState @@ -562,10 +562,10 @@

Properties

- +
-
errors +
errors @@ -584,10 +584,10 @@

Properties

- +
-
lastAction +
lastAction @@ -606,10 +606,10 @@

Properties

- +
-
transitions +
transitions diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/last-action.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/last-action.html index 1d27728..4cac804 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/last-action.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/last-action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/lastAction

lastAction

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-errors.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-errors.html index 3cf431b..1562a08 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-errors.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-errors.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/observeErrors

observeErrors

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-transitions.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-transitions.html index 2cc235e..5bf6aaf 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-transitions.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/observe-transitions.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/observeTransitions

observeTransitions

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-error-handler.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-error-handler.html index 12d2bba..75c50d7 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-error-handler.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-error-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/removeErrorHandler

removeErrorHandler

@@ -34,7 +34,7 @@

removeError
-
abstract fun removeErrorHandler(handler: ErrorHandler) +
abstract fun removeErrorHandler(handler: ErrorHandler)
diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-transition-handler.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-transition-handler.html index 7f78323..7c42b6e 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-transition-handler.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/remove-transition-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/removeTransitionHandler

removeTransitionHandler

@@ -34,7 +34,7 @@

removeTransition
-
abstract fun removeTransitionHandler(handler: TransitionHandler) +
abstract fun removeTransitionHandler(handler: TransitionHandler)
diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-default-dispatcher.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-default-dispatcher.html index beff475..e0226bf 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-default-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-default-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/setDefaultDispatcher

setDefaultDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-error-handler-dispatcher.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-error-handler-dispatcher.html index 5b58bb4..41e8c36 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-error-handler-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-error-handler-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/setErrorHandlerDispatcher

setErrorHandlerDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-initial-state.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-initial-state.html index b8cc709..fd7f58c 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-initial-state.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-initial-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/setInitialState

setInitialState

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-strict-state-matching.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-strict-state-matching.html index dbdc48d..037054b 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-strict-state-matching.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-strict-state-matching.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/setStrictStateMatching

setStrictStateMatching

@@ -40,7 +40,7 @@

setStrict Content copied to clipboard

-

Allows the caller to switch between strict and loose state matching modes. When transitioning using an action, the state machine will try to find the resulting state by looking for the current state and the given action.

Default value is true (strict mode).

Strict matching

With strict matching, current state and the new action will be compared using Any.equals, which means that state/action type, name and payload all must match their stored mappings. An example:

object AB : SingletonAction()
object A : SingletonState()
object B : SingletonState()

val sm = stateMachine {
  mappings(AB moves A to B)
  initialState = A
}

// fails and reports an error (mismatch: payload and state type)
sm.transition(namedState("AB"))

Loose matching

In contrast to strict state matching, loose matching will allow you to process actions during the transition phase even though the payload or action/state type are different from the ones in the mapping list. The only thing compared will be the name property of the action/state. An example:

object AB : SingletonAction()
object A : SingletonState()
object B : SingletonState()

val sm = stateMachine {
  mappings(AB moves A to B)
  initialState = A
}

sm.transition(namedState("AB"))
println(sm.currentState) // B, because only 'AB' name is being matched

Use-cases

Loose matching is extremely useful if you want to send a different payload with the same action name, for example. Another use-case would be using an internally-mutable payload in a state - that would not match the initial payload provided in the state mapping block.

+

Allows the caller to switch between strict and loose state matching modes. When transitioning using an action, the state machine will try to find the resulting state by looking for the current state and the given action.

Default value is true (strict mode).

Strict matching

With strict matching, current state and the new action will be compared using Any.equals, which means that state/action type, name and payload all must match their stored mappings. An example:

object AB : SingletonAction()
object A : SingletonState()
object B : SingletonState()

val sm = stateMachine {
  mappings(AB moves A to B)
  initialState = A
}

// fails and reports an error (mismatch: payload and state type)
sm.transition(namedState("AB"))

Loose matching

In contrast to strict state matching, loose matching will allow you to process actions during the transition phase even though the payload or action/state type are different from the ones in the mapping list. The only thing compared will be the name property of the action/state. An example:

object AB : SingletonAction()
object A : SingletonState()
object B : SingletonState()

val sm = stateMachine {
  mappings(AB moves A to B)
  initialState = A
}

sm.transition(namedState("AB"))
println(sm.currentState) // B, because only 'AB' name is being matched

Use-cases

Loose matching is extremely useful if you want to send a different payload with the same action name, for example. Another use-case would be using an internally-mutable payload in a state - that would not match the initial payload provided in the state mapping block.

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-transition-handler-dispatcher.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-transition-handler-dispatcher.html index cf8a3bd..950199a 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-transition-handler-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/set-transition-handler-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/setTransitionHandlerDispatcher

setTransitionHandlerDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/transition.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/transition.html index 5545961..5ebaf87 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/transition.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/transition.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/transition

transition

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state-machine/transitions.html b/docs/kssm/me.angrybyte.kssm.api/-state-machine/transitions.html index a708908..12b4101 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state-machine/transitions.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state-machine/transitions.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/StateMachine/transitions

transitions

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state/index.html b/docs/kssm/me.angrybyte.kssm.api/-state/index.html index 5db54f0..c836b9f 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state/index.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/State

State

@@ -48,10 +48,10 @@

Parameters

T

the state's payload type

Functions

-
+
-
equals +
equals @@ -63,7 +63,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -74,10 +74,10 @@

Functions

- +
-
hashCode +
hashCode @@ -89,7 +89,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -100,10 +100,10 @@

Functions

- +
-
toString +
toString @@ -115,7 +115,7 @@

Functions

-
open fun toString(): String +
open fun toString(): String
@@ -128,10 +128,10 @@

Functions

Properties

-
+
-
name +
name @@ -150,10 +150,10 @@

Properties

- +
-
payload +
payload @@ -174,10 +174,10 @@

Properties

Inheritors

-
+
-
SingletonState +
SingletonState @@ -190,10 +190,10 @@

Inheritors

Extensions

-
+
-
requirePayload +
requirePayload @@ -211,7 +211,7 @@

Extensions

Content copied to clipboard
-
Force casts the payload object into a non-null value of type T and returns it.
+
Force casts the payload object into a non-null value of type T and returns it.
diff --git a/docs/kssm/me.angrybyte.kssm.api/-state/name.html b/docs/kssm/me.angrybyte.kssm.api/-state/name.html index a05ca46..082ac5a 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state/name.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state/name.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/State/name

name

diff --git a/docs/kssm/me.angrybyte.kssm.api/-state/payload.html b/docs/kssm/me.angrybyte.kssm.api/-state/payload.html index 57ac265..3885a11 100644 --- a/docs/kssm/me.angrybyte.kssm.api/-state/payload.html +++ b/docs/kssm/me.angrybyte.kssm.api/-state/payload.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api/State/payload

payload

diff --git a/docs/kssm/me.angrybyte.kssm.api/index.html b/docs/kssm/me.angrybyte.kssm.api/index.html index 8a12df4..f1f2753 100644 --- a/docs/kssm/me.angrybyte.kssm.api/index.html +++ b/docs/kssm/me.angrybyte.kssm.api/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.api

Package me.angrybyte.kssm.api

@@ -35,10 +35,10 @@

Package me.angrybyte.

Types

-
+
-
Action +
Action @@ -56,15 +56,15 @@

Types

Content copied to clipboard
-
A fundamental building block of a StateMachine.
+
A fundamental building block of a StateMachine.
- +
-
ErrorHandler +
ErrorHandler @@ -76,21 +76,21 @@

Types

-
typealias ErrorHandler = suspend (error: Throwable) -> Unit +
typealias ErrorHandler = suspend (error: Throwable) -> Unit
Content copied to clipboard
-

A suspending shorthand for reacting to Throwables coming from a StateMachine.

+

A suspending shorthand for reacting to Throwables coming from a StateMachine.

- +
-
State +
State @@ -108,15 +108,15 @@

Types

Content copied to clipboard
-
A fundamental building block of a StateMachine.
+
A fundamental building block of a StateMachine.
- +
-
StateMachine +
StateMachine @@ -134,15 +134,15 @@

Types

Content copied to clipboard
-
The public-facing API for configuring, using and observing changes within a finite state machine.
+
The public-facing API for configuring, using and observing changes within a finite state machine.
- +
-
TransitionHandler +
TransitionHandler @@ -154,13 +154,13 @@

Types

-
typealias TransitionHandler = suspend (transition: Transition<*, *, *>) -> Unit +
typealias TransitionHandler = suspend (transition: Transition<*, *, *>) -> Unit
Content copied to clipboard
-

A suspending shorthand for reacting to Transitions coming from a StateMachine.

+

A suspending shorthand for reacting to Transitions coming from a StateMachine.

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/-state-machine-dsl.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/-state-machine-dsl.html index 1a709e3..ebfbd81 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/-state-machine-dsl.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/-state-machine-dsl.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/StateMachineDsl

StateMachineDsl

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/default-dispatcher.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/default-dispatcher.html index a6d4b02..afd1f50 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/default-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/default-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/defaultDispatcher

defaultDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/error-handler.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/error-handler.html index 8b0d343..f6a5e37 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/error-handler.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/error-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/errorHandler

errorHandler

@@ -34,7 +34,7 @@

errorHandler

-
fun errorHandler(handler: ErrorHandler): StateMachineDsl +
fun errorHandler(handler: ErrorHandler): StateMachineDsl
diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/errors-dispatcher.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/errors-dispatcher.html index 58ee03d..09fbe5e 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/errors-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/errors-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/errorsDispatcher

errorsDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/index.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/index.html index 4e31409..f12c31a 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/index.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl

StateMachineDsl

@@ -44,10 +44,10 @@

See also

Constructors

-
+
-
StateMachineDsl +
StateMachineDsl @@ -68,10 +68,10 @@

Constructors

Functions

-
+
-
equals +
equals @@ -83,7 +83,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -94,10 +94,10 @@

Functions

- +
-
errorHandler +
errorHandler @@ -109,21 +109,21 @@

Functions

-
fun errorHandler(handler: ErrorHandler): StateMachineDsl +
fun errorHandler(handler: ErrorHandler): StateMachineDsl
Content copied to clipboard
-
Adds a new inline error handler.
+
Adds a new inline error handler.
- +
-
hashCode +
hashCode @@ -135,7 +135,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -146,10 +146,10 @@

Functions

- +
-
mappings +
mappings @@ -167,15 +167,15 @@

Functions

Content copied to clipboard
-
Takes a list of StateMappings and adds them into the state machine.
+
Takes a list of StateMappings and adds them into the state machine.
- +
-
toString +
toString @@ -187,7 +187,7 @@

Functions

-
open fun toString(): String +
open fun toString(): String
@@ -198,10 +198,10 @@

Functions

- +
-
transitionHandler +
transitionHandler @@ -213,23 +213,23 @@

Functions

-
fun transitionHandler(handler: TransitionHandler): StateMachineDsl +
fun transitionHandler(handler: TransitionHandler): StateMachineDsl
Content copied to clipboard
-
Adds a new inline transition handler.
+
Adds a new inline transition handler.

Properties

-
+
-
defaultDispatcher +
defaultDispatcher @@ -248,10 +248,10 @@

Properties

- +
-
errorsDispatcher +
errorsDispatcher @@ -270,10 +270,10 @@

Properties

- +
-
initialState +
initialState @@ -292,10 +292,10 @@

Properties

- +
-
transitionsDispatcher +
transitionsDispatcher @@ -314,10 +314,10 @@

Properties

- +
-
useStrictMatching +
useStrictMatching diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/initial-state.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/initial-state.html index b54e801..a3528db 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/initial-state.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/initial-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/initialState

initialState

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/mappings.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/mappings.html index f1ca3e0..8273166 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/mappings.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/mappings.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/mappings

mappings

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transition-handler.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transition-handler.html index f4348b2..d7bf4e1 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transition-handler.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transition-handler.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/transitionHandler

transitionHandler

@@ -34,7 +34,7 @@

transitionHandler

-
fun transitionHandler(handler: TransitionHandler): StateMachineDsl +
fun transitionHandler(handler: TransitionHandler): StateMachineDsl
diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transitions-dispatcher.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transitions-dispatcher.html index 540d51b..b34c82e 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transitions-dispatcher.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/transitions-dispatcher.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/transitionsDispatcher

transitionsDispatcher

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/use-strict-matching.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/use-strict-matching.html index 17319ec..067962f 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/use-strict-matching.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-machine-dsl/use-strict-matching.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateMachineDsl/useStrictMatching

useStrictMatching

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/-state-vector.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/-state-vector.html index 1b7d2c8..e2ce18a 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/-state-vector.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/-state-vector.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/StateVector

StateVector

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/action.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/action.html index 396cace..ba47b8e 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/action.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/action

action

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component1.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component1.html index 6b8a9b8..90f0277 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component1.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component1.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/component1

component1

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component2.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component2.html index 44edfcd..bd66747 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component2.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/component2.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/component2

component2

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/copy.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/copy.html index ade0880..6d20f4f 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/copy.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/copy.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/copy

copy

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/index.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/index.html index 49799ee..24f088f 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/index.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector

StateVector

@@ -40,10 +40,10 @@

StateVector

Constructors

-
+
-
StateVector +
StateVector @@ -64,10 +64,10 @@

Constructors

Functions

-
+
-
component1 +
component1 @@ -90,10 +90,10 @@

Functions

- +
-
component2 +
component2 @@ -116,10 +116,10 @@

Functions

- +
-
copy +
copy @@ -142,10 +142,10 @@

Functions

- +
-
equals +
equals @@ -157,7 +157,7 @@

Functions

-
open operator override fun equals(other: Any?): Boolean +
open operator override fun equals(other: Any?): Boolean
@@ -168,10 +168,10 @@

Functions

- +
-
hashCode +
hashCode @@ -183,7 +183,7 @@

Functions

-
open override fun hashCode(): Int +
open override fun hashCode(): Int
@@ -194,10 +194,10 @@

Functions

- +
-
toString +
toString @@ -209,7 +209,7 @@

Functions

-
open override fun toString(): String +
open override fun toString(): String
@@ -222,10 +222,10 @@

Functions

Properties

-
+
-
action +
action @@ -244,10 +244,10 @@

Properties

- +
-
source +
source @@ -268,10 +268,10 @@

Properties

Extensions

-
+
-
to +
to @@ -289,7 +289,7 @@

Extensions

Content copied to clipboard
-
Binds the source State and an Action from a StateVector with a destination state into a StateMapping.
+
Binds the source State and an Action from a StateVector with a destination state into a StateMapping.
diff --git a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/source.html b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/source.html index 75e6d63..5003dee 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/source.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/-state-vector/source.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/StateVector/source

source

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/index.html b/docs/kssm/me.angrybyte.kssm.dsl/index.html index 43989c6..609e421 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/index.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl

Package me.angrybyte.kssm.dsl

@@ -35,10 +35,10 @@

Package me.angrybyte.

Types

-
+
-
StateMachineDsl +
StateMachineDsl @@ -56,15 +56,15 @@

Types

Content copied to clipboard
-
The DSL (domain-specific language) wrapper.
+
The DSL (domain-specific language) wrapper.
- +
-
StateVector +
StateVector @@ -82,17 +82,17 @@

Types

Content copied to clipboard
-
Holds a State and an Action, without knowing anything about the resulting state.
+
Holds a State and an Action, without knowing anything about the resulting state.

Functions

-
+
-
moves +
moves @@ -110,15 +110,15 @@

Functions

Content copied to clipboard
-
Binds an Action and a source State into a StateVector.
+
Binds an Action and a source State into a StateVector.
- +
-
namedAction +
namedAction @@ -136,15 +136,15 @@

Functions

Content copied to clipboard
-
Simplifies creation of a new NamedAction instance.
+
Simplifies creation of a new NamedAction instance.
- +
-
namedState +
namedState @@ -162,15 +162,15 @@

Functions

Content copied to clipboard
-
Simplifies creation of a new NamedState instance.
+
Simplifies creation of a new NamedState instance.
- +
-
payloadAction +
payloadAction @@ -188,15 +188,15 @@

Functions

Content copied to clipboard
-
Simplifies creation of a new PayloadAction instance.
+
Simplifies creation of a new PayloadAction instance.
- +
-
payloadState +
payloadState @@ -214,15 +214,15 @@

Functions

Content copied to clipboard
-
Simplifies creation of a new PayloadState instance.
+
Simplifies creation of a new PayloadState instance.
- +
-
stateMachine +
stateMachine @@ -234,31 +234,31 @@

Functions

-
@ExperimentalCoroutinesApi()
fun stateMachine(): StateMachine +
fun stateMachine(): StateMachine
Content copied to clipboard
-
Starts the DSL (StateMachineDsl) without a configuration block on a new state machine instance.
+
Starts the DSL (StateMachineDsl) without a configuration block on a new state machine instance.
-
@ExperimentalCoroutinesApi()
fun stateMachine(initialize: StateMachineDsl.() -> Unit): StateMachine +
fun stateMachine(initialize: StateMachineDsl.() -> Unit): StateMachine
Content copied to clipboard
-
Starts the DSL (StateMachineDsl) with a configuration block on a new state machine instance.
+
Starts the DSL (StateMachineDsl) with a configuration block on a new state machine instance.
- +
-
to +
to @@ -276,7 +276,7 @@

Functions

Content copied to clipboard
-
Binds the source State and an Action from a StateVector with a destination state into a StateMapping.
+
Binds the source State and an Action from a StateVector with a destination state into a StateMapping.
diff --git a/docs/kssm/me.angrybyte.kssm.dsl/moves.html b/docs/kssm/me.angrybyte.kssm.dsl/moves.html index 5cb8601..7fd5c7e 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/moves.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/moves.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/moves

moves

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/named-action.html b/docs/kssm/me.angrybyte.kssm.dsl/named-action.html index 29fb317..cd2c1f0 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/named-action.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/named-action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/namedAction

namedAction

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/named-state.html b/docs/kssm/me.angrybyte.kssm.dsl/named-state.html index 3b95a0e..a251b06 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/named-state.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/named-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/namedState

namedState

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/payload-action.html b/docs/kssm/me.angrybyte.kssm.dsl/payload-action.html index cf19c18..495a2bf 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/payload-action.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/payload-action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/payloadAction

payloadAction

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/payload-state.html b/docs/kssm/me.angrybyte.kssm.dsl/payload-state.html index ff4e182..52e8d05 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/payload-state.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/payload-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/payloadState

payloadState

diff --git a/docs/kssm/me.angrybyte.kssm.dsl/state-machine.html b/docs/kssm/me.angrybyte.kssm.dsl/state-machine.html index 7ebd4ea..29acf83 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/state-machine.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/state-machine.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/stateMachine

stateMachine

@@ -34,7 +34,7 @@

stateMachine

-
@ExperimentalCoroutinesApi()
fun stateMachine(initialize: StateMachineDsl.() -> Unit): StateMachine +
fun stateMachine(initialize: StateMachineDsl.() -> Unit): StateMachine
@@ -44,7 +44,7 @@

stateMachine

-
@ExperimentalCoroutinesApi()
fun stateMachine(): StateMachine +
fun stateMachine(): StateMachine
diff --git a/docs/kssm/me.angrybyte.kssm.dsl/to.html b/docs/kssm/me.angrybyte.kssm.dsl/to.html index 91988f4..43a282d 100644 --- a/docs/kssm/me.angrybyte.kssm.dsl/to.html +++ b/docs/kssm/me.angrybyte.kssm.dsl/to.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.dsl/to

to

diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/-singleton-action.html b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/-singleton-action.html index 5e207f9..e2da5f0 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/-singleton-action.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/-singleton-action.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action/SingletonAction/SingletonAction

SingletonAction

diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/index.html b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/index.html index c2ba7ae..4dc006d 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/index.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action/SingletonAction

SingletonAction

@@ -40,10 +40,10 @@

SingletonAction

Constructors

-
+
-
SingletonAction +
SingletonAction @@ -64,10 +64,10 @@

Constructors

Functions

-
+
-
equals +
equals @@ -79,7 +79,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -90,10 +90,10 @@

Functions

- +
-
hashCode +
hashCode @@ -105,7 +105,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -116,10 +116,10 @@

Functions

- +
-
toString +
toString @@ -144,10 +144,10 @@

Functions

Properties

-
+
-
name +
name @@ -166,10 +166,10 @@

Properties

- +
-
payload +
payload diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/name.html b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/name.html index f372298..7d717f5 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/name.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/name.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action/SingletonAction/name

name

diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/payload.html b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/payload.html index a65f01d..410f3da 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/payload.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/payload.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action/SingletonAction/payload

payload

diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/to-string.html b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/to-string.html index f53460a..551408c 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/to-string.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/-singleton-action/to-string.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action/SingletonAction/toString

toString

diff --git a/docs/kssm/me.angrybyte.kssm.impl.action/index.html b/docs/kssm/me.angrybyte.kssm.impl.action/index.html index 6ce9768..da5adf8 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.action/index.html +++ b/docs/kssm/me.angrybyte.kssm.impl.action/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.action

Package me.angrybyte.kssm.impl.action

@@ -35,10 +35,10 @@

Package me.angrybyte.

Types

-
+
-
SingletonAction +
SingletonAction @@ -56,7 +56,7 @@

Types

Content copied to clipboard
-
A simple Action implementation that uses the inheritor's class name as action name.
+
A simple Action implementation that uses the inheritor's class name as action name.
diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/-singleton-state.html b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/-singleton-state.html index 7b002ca..35c8402 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/-singleton-state.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/-singleton-state.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state/SingletonState/SingletonState

SingletonState

diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/index.html b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/index.html index f33a635..c16a819 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/index.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state/SingletonState

SingletonState

@@ -40,10 +40,10 @@

SingletonState

Constructors

-
+
-
SingletonState +
SingletonState @@ -64,10 +64,10 @@

Constructors

Functions

-
+
-
equals +
equals @@ -79,7 +79,7 @@

Functions

-
open operator fun equals(other: Any?): Boolean +
open operator fun equals(other: Any?): Boolean
@@ -90,10 +90,10 @@

Functions

- +
-
hashCode +
hashCode @@ -105,7 +105,7 @@

Functions

-
open fun hashCode(): Int +
open fun hashCode(): Int
@@ -116,10 +116,10 @@

Functions

- +
-
toString +
toString @@ -144,10 +144,10 @@

Functions

Properties

-
+
-
name +
name @@ -166,10 +166,10 @@

Properties

- +
-
payload +
payload diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/name.html b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/name.html index bc65094..66ed811 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/name.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/name.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state/SingletonState/name

name

diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/payload.html b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/payload.html index 032b01b..f1df0c5 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/payload.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/payload.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state/SingletonState/payload

payload

diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/to-string.html b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/to-string.html index 5ef4f57..e6d2738 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/to-string.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/-singleton-state/to-string.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state/SingletonState/toString

toString

diff --git a/docs/kssm/me.angrybyte.kssm.impl.state/index.html b/docs/kssm/me.angrybyte.kssm.impl.state/index.html index 6ea664b..e1e52ad 100644 --- a/docs/kssm/me.angrybyte.kssm.impl.state/index.html +++ b/docs/kssm/me.angrybyte.kssm.impl.state/index.html @@ -26,7 +26,7 @@ -
+
kssm/me.angrybyte.kssm.impl.state

Package me.angrybyte.kssm.impl.state

@@ -35,10 +35,10 @@

Package me.angrybyte.

Types

-
+
-
SingletonState +
SingletonState @@ -56,7 +56,7 @@

Types

Content copied to clipboard
-
A simple State implementation that uses the inheritor's class name as state name.
+
A simple State implementation that uses the inheritor's class name as state name.
diff --git a/docs/navigation.html b/docs/navigation.html index 7fb8ffa..16a5c6a 100644 --- a/docs/navigation.html +++ b/docs/navigation.html @@ -1,77 +1,77 @@ -