MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.fsm.repos.common/[jvm]-key-value-based-default-states-manager-repo/index.html

142 lines
15 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>[jvm]KeyValueBasedDefaultStatesManagerRepo</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.repos.common/KeyValueBasedDefaultStatesManagerRepo///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.repos.common</a>/<a href="index.html">[jvm]KeyValueBasedDefaultStatesManagerRepo</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></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Key</span><wbr></wbr><span>Value</span><wbr></wbr><span>Based</span><wbr></wbr><span>Default</span><wbr></wbr><span>States</span><wbr></wbr><span>Manager</span><wbr></wbr><span><span>Repo</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">class <a href="index.html">KeyValueBasedDefaultStatesManagerRepo</a>(keyValueRepo: <a href="../../dev.inmo.micro_utils.repos/index.html#684390073%2FClasslikes%2F-1052446920">KeyValueRepo</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>, <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</a>&gt;) : <a href="../../dev.inmo.micro_utils.fsm.common.managers/[jvm]-default-states-manager-repo/index.html">DefaultStatesManagerRepo</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="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-2086719926%2FFunctions%2F-1052446920" anchor-label="contains" id="-2086719926%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="contains.html"><span><span>contains</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2086719926%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="contains.html">contains</a>(context: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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="-1037454277%2FFunctions%2F-1052446920" anchor-label="getContextState" id="-1037454277%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="get-context-state.html"><span>get</span><wbr></wbr><span>Context</span><wbr></wbr><span><span>State</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1037454277%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="get-context-state.html">getContextState</a>(context: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>): <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</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="2127552282%2FFunctions%2F-1052446920" anchor-label="getStates" id="2127552282%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="get-states.html"><span>get</span><wbr></wbr><span><span>States</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2127552282%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="get-states.html">getStates</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;<a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</a>&gt;<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="-1060586277%2FFunctions%2F-1052446920" anchor-label="removeState" id="-1060586277%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="remove-state.html"><span>remove</span><wbr></wbr><span><span>State</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1060586277%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="remove-state.html">removeState</a>(state: <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</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">Remove exactly <a href="remove-state.html">state</a>. In case if internally <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/context.html">State.context</a> is busy with different <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</a>, that <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</a> should NOT be removed</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="1779103504%2FFunctions%2F-1052446920" anchor-label="set" id="1779103504%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="set.html"><span><span>set</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1779103504%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="set.html">set</a>(state: <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/index.html">State</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">Must save <a href="set.html">state</a> as current state of chain with <a href="../../dev.inmo.micro_utils.fsm.common/[jvm]-state/context.html">State.context</a> of <a href="set.html">state</a></p></div></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>