mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-07 17:03:49 +00:00
171 lines
22 KiB
HTML
171 lines
22 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>[jvm]DefaultStatesMachine</title>
|
|
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.fsm.common/DefaultStatesMachine///PointingToDeclaration//-1052446920">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a>/<a href="../index.html">dev.inmo.micro_utils.fsm.common</a>/<a href="index.html">[jvm]DefaultStatesMachine</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/androidMain">android</button><button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Default</span><wbr></wbr><span>States</span><wbr></wbr><span><span>Machine</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open class <a href="index.html">DefaultStatesMachine</a><<a href="index.html">T</a> : <a href="../[jvm]-state/index.html">State</a>>(statesManager: <a href="../[jvm]-states-manager/index.html">StatesManager</a><<a href="index.html">T</a>>, handlers: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="../[jvm]-checkable-handler-holder/index.html">CheckableHandlerHolder</a><in <a href="index.html">T</a>, <a href="index.html">T</a>>>) : <a href="../[jvm]-states-machine/index.html">StatesMachine</a><<a href="index.html">T</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Default realization of <a href="../[jvm]-states-machine/index.html">StatesMachine</a>. It uses <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/statesManager/#/PointingToDeclaration/">statesManager</span> for incapsulation of <a href="../[jvm]-state/index.html">State</a>s storing and contexts resolving, and uses <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/launchStateHandling/#TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])#kotlin.collections.List[dev.inmo.micro_utils.fsm.common.CheckableHandlerHolder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]/PointingToDeclaration/">launchStateHandling</span> for <a href="../[jvm]-state/index.html">State</a> handling.</p><p class="paragraph">This class suppose to be extended in case you wish some custom behaviour inside of <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/launchStateHandling/#TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])#kotlin.collections.List[dev.inmo.micro_utils.fsm.common.CheckableHandlerHolder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]/PointingToDeclaration/">launchStateHandling</span>, for example</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="tabbedcontent">Constructors</h2>
|
|
<div class="table" data-togglable="Constructors"><a data-name="809174968%2FConstructors%2F-1052446920" anchor-label="DefaultStatesMachine" id="809174968%2FConstructors%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue TabbedContent">
|
|
<div class=""><span class="inline-flex"><a href="-default-states-machine.html">DefaultStatesMachine</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="809174968%2FConstructors%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">fun <<a href="index.html">T</a> : <a href="../[jvm]-state/index.html">State</a>> <a href="-default-states-machine.html">DefaultStatesMachine</a>(statesManager: <a href="../[jvm]-states-manager/index.html">StatesManager</a><<a href="index.html">T</a>>, handlers: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="../[jvm]-checkable-handler-holder/index.html">CheckableHandlerHolder</a><in <a href="index.html">T</a>, <a href="index.html">T</a>>>)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-1429929647%2FFunctions%2F-1052446920" anchor-label="handleState" id="-1429929647%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="handle-state.html"><span>handle</span><wbr></wbr><span><span>State</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1429929647%2FFunctions%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open suspend override fun <a href="../[jvm]-states-machine/index.html">StatesMachine</a><in <a href="index.html">T</a>>.<a href="handle-state.html">handleState</a>(state: <a href="index.html">T</a>): <a href="index.html">T</a>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<div class="brief "><p class="paragraph">Will call <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/launchStateHandling/#TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])#kotlin.collections.List[dev.inmo.micro_utils.fsm.common.CheckableHandlerHolder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]/PointingToDeclaration/">launchStateHandling</span> for state handling</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1673894440%2FFunctions%2F-1052446920" anchor-label="launchStateHandling" id="-1673894440%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="../[jvm]-states-machine/launch-state-handling.html"><span>launch</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Handling</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1673894440%2FFunctions%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open suspend fun <a href="../[jvm]-states-machine/launch-state-handling.html">launchStateHandling</a>(state: <a href="index.html">T</a>, handlers: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="../[jvm]-checkable-handler-holder/index.html">CheckableHandlerHolder</a><in <a href="index.html">T</a>, <a href="index.html">T</a>>>): <a href="index.html">T</a>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1723185228%2FFunctions%2F-1052446920" anchor-label="performStateUpdate" id="1723185228%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="perform-state-update.html"><span>perform</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Update</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1723185228%2FFunctions%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open suspend fun <a href="perform-state-update.html">performStateUpdate</a>(previousState: <a href="../../dev.inmo.micro_utils.common/[jvm]-optional/index.html">Optional</a><<a href="index.html">T</a>>, actualState: <a href="index.html">T</a>, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="180131764%2FFunctions%2F-1052446920" anchor-label="start" id="180131764%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="start.html"><span><span>start</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="180131764%2FFunctions%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open override fun <a href="start.html">start</a>(scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<div class="brief "><p class="paragraph">Launch handling of states. On <a href="../[jvm]-states-manager/on-start-chain.html">statesManager</a>, <a href="../[jvm]-states-manager/on-chain-state-updated.html">statesManager</a> will be called lambda with performing of state. If <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/launchStateHandling/#TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])#kotlin.collections.List[dev.inmo.micro_utils.fsm.common.CheckableHandlerHolder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]/PointingToDeclaration/">launchStateHandling</span> will returns some <a href="../[jvm]-state/index.html">State</a> then <a href="../[jvm]-states-manager/update.html">statesManager</a> will be used, otherwise <a href="../[jvm]-states-manager/end-chain.html">StatesManager.endChain</a>.</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="704297849%2FFunctions%2F-1052446920" anchor-label="startChain" id="704297849%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="start-chain.html"><span>start</span><wbr></wbr><span><span>Chain</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="704297849%2FFunctions%2F-1052446920"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace">open suspend override fun <a href="start-chain.html">startChain</a>(state: <a href="index.html">T</a>)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<div class="brief "><p class="paragraph">Just calls <a href="../[jvm]-states-manager/start-chain.html">StatesManager.startChain</a> of <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultStatesMachine/statesManager/#/PointingToDeclaration/">statesManager</span></p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Inheritors</h2>
|
|
<div class="table" data-togglable="Inheritors"><a data-name="1080667633%2FInheritors%2F1737121690" anchor-label="DefaultUpdatableStatesMachine" id="1080667633%2FInheritors%2F1737121690" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain"></a>
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/DefaultUpdatableStatesMachine///PointingToDeclaration/">DefaultUpdatableStatesMachine</span><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1080667633%2FInheritors%2F1737121690"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|