mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-05 07:53:48 +00:00
153 lines
17 KiB
HTML
153 lines
17 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||
|
|
<title>[common]UpdatableStatesMachine</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/UpdatableStatesMachine///PointingToDeclaration//-1478683138">
|
||
|
|
<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">[common]UpdatableStatesMachine</a></div>
|
||
|
|
<div class="pull-right d-flex">
|
||
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</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 jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
|
||
|
|
<div id="searchBar"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="cover ">
|
||
|
|
<h1 class="cover"><span>Updatable</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/commonMain"><div class="symbol monospace">interface <a href="index.html">UpdatableStatesMachine</a><<a href="index.html">T</a> : <a href="../[common]-state/index.html">State</a>> : <a href="../[common]-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">This extender of <a href="../[common]-states-machine/index.html">StatesMachine</a> interface declare one new function <a href="update-chain.html">updateChain</a>. Realizations of this interface must be able to perform update of chain in internal <a href="../[common]-states-manager/index.html">StatesManager</a></p></div></div>
|
||
|
|
</div>
|
||
|
|
<div class="tabbedcontent">
|
||
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
|
||
|
|
<div class="tabs-section-body">
|
||
|
|
<h2 class="">Functions</h2>
|
||
|
|
<div class="table" data-togglable="Functions"><a data-name="1210167093%2FFunctions%2F-1478683138" anchor-label="handleState" id="1210167093%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex"><a href="../[common]-states-handler/handle-state.html"><span>handle</span><wbr></wbr><span><span>State</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1210167093%2FFunctions%2F-1478683138"></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 common-like">common</div>
|
||
|
|
</div>
|
||
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">abstract suspend fun <a href="../[common]-states-machine/index.html">StatesMachine</a><in <a href="index.html">T</a>>.<a href="../[common]-states-handler/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">Main handling of <a href="../[common]-states-handler/handle-state.html">state</a>. In case when this <a href="../[common]-states-handler/handle-state.html">state</a> leads to another <a href="../[common]-state/index.html">State</a> and <a href="../[common]-states-handler/handle-state.html">handleState</a> returns not null <a href="../[common]-state/index.html">State</a> it is assumed that chain is not completed.</p></div></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a data-name="-1673894440%2FFunctions%2F-1478683138" anchor-label="launchStateHandling" id="-1673894440%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex"><a href="../[common]-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-1478683138"></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 common-like">common</div>
|
||
|
|
</div>
|
||
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">open suspend fun <a href="../[common]-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="../[common]-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="1816937877%2FFunctions%2F-1478683138" anchor-label="start" id="1816937877%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex"><a href="../[common]-states-machine/start.html"><span><span>start</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1816937877%2FFunctions%2F-1478683138"></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 common-like">common</div>
|
||
|
|
</div>
|
||
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">abstract fun <a href="../[common]-states-machine/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">Starts handling of <a href="../[common]-state/index.html">State</a>s</p></div></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a data-name="-1903622856%2FFunctions%2F-1478683138" anchor-label="startChain" id="-1903622856%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex"><a href="../[common]-states-machine/start-chain.html"><span>start</span><wbr></wbr><span><span>Chain</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1903622856%2FFunctions%2F-1478683138"></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 common-like">common</div>
|
||
|
|
</div>
|
||
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">abstract suspend fun <a href="../[common]-states-machine/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">Start chain of <a href="../[common]-state/index.html">State</a>s witn <a href="../[common]-states-machine/start-chain.html">state</a></p></div></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a data-name="-1587467804%2FFunctions%2F-1478683138" anchor-label="updateChain" id="-1587467804%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex"><a href="update-chain.html"><span>update</span><wbr></wbr><span><span>Chain</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1587467804%2FFunctions%2F-1478683138"></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 common-like">common</div>
|
||
|
|
</div>
|
||
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">abstract suspend fun <a href="update-chain.html">updateChain</a>(currentState: <a href="index.html">T</a>, newState: <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">Update chain with current state equal to <a href="update-chain.html">currentState</a> with <a href="update-chain.html">newState</a>. Behaviour of this update preforming in cases when <a href="update-chain.html">currentState</a> does not exist in <a href="../[common]-states-manager/index.html">StatesManager</a> must be declared inside of realization of <a href="../[common]-states-manager/update.html">StatesManager.update</a> function</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>
|
||
|
|
|