mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-27 12:38:46 +00:00
146 lines
18 KiB
HTML
146 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>CustomizableHandlerHolder</title>
|
|
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
<script>var pathToRoot = "../../../";</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
|
|
<link href="../../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../../styles/logo-styles.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" defer="defer"></script>
|
|
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
|
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<div class="library-name">
|
|
<a href="../../../index.html">
|
|
<span>micro_utils.dokka</span>
|
|
</a>
|
|
</div>
|
|
<div>
|
|
0.19.5 </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>
|
|
</div>
|
|
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div id="container">
|
|
<div id="leftColumn">
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" data-page-type="classlike" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.fsm.common/CustomizableHandlerHolder///PointingToDeclaration//-1478683138">
|
|
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.micro_utils.fsm.common</a><span class="delimiter">/</span><span class="current">CustomizableHandlerHolder</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Customizable</span><wbr></wbr><span>Handler</span><wbr></wbr><span><span>Holder</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator"> : </span><a href="index.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delegateTo<span class="token operator">: </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>state<span class="token operator">: </span><a href="index.html">O</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span> : <a href="../-checkable-handler-holder/index.html">CheckableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">> </span></div><p class="paragraph">Default realization of <a href="../-states-handler/index.html">StatesHandler</a>. It will incapsulate checking of <a href="../-state/index.html">State</a> type in <a href="check-handleable.html">checkHandleable</a> and class casting in <a href="handle-state.html">handleState</a></p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="CONSTRUCTOR">
|
|
<h2 class="">Constructors</h2>
|
|
<div class="table"><a data-name="-1426844370%2FConstructors%2F-1478683138" anchor-label="CustomizableHandlerHolder" id="-1426844370%2FConstructors%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="CONSTRUCTOR" 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">
|
|
<div><a href="-customizable-handler-holder.html"><span>Customizable</span><wbr></wbr><span>Handler</span><wbr></wbr><span><span>Holder</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1426844370%2FConstructors%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="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delegateTo<span class="token operator">: </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>state<span class="token operator">: </span><a href="index.html">O</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="-110026684%2FFunctions%2F-1478683138" anchor-label="checkHandleable" id="-110026684%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">
|
|
<div><a href="check-handleable.html"><span>check</span><wbr></wbr><span><span>Handleable</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-110026684%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="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="check-handleable.html"><span class="token function">checkHandleable</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Checks that <a href="check-handleable.html">state</a> can be handled by <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/CustomizableHandlerHolder/delegateTo/#/PointingToDeclaration/">delegateTo</span>. Under the hood it will check exact equality of <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">state</a> and use <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/is-instance.html">KClass.isInstance</a> of inputKlass if strict == false</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1405605635%2FFunctions%2F-1478683138" anchor-label="handleState" id="1405605635%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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">
|
|
<div><a href="handle-state.html"><span>handle</span><wbr></wbr><span><span>State</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1405605635%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="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="../-states-machine/index.html">StatesMachine</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="handle-state.html"><span class="token function">handleState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">I</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">O</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Calls <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/CustomizableHandlerHolder/delegateTo/#/PointingToDeclaration/">delegateTo</span> method <a href="../-states-handler/handle-state.html">StatesHandler.handleState</a> with <a href="handle-state.html">state</a> casted to <a href="index.html">I</a>. Use <a href="check-handleable.html">checkHandleable</a> to be sure that this StatesHandlerHolder will be able to handle <a href="handle-state.html">state</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1180048627%2FFunctions%2F-1478683138" anchor-label="holder" id="1180048627%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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">
|
|
<div><a href="../holder.html"><span><span>holder</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1180048627%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="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">strict<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>state<span class="token operator">: </span><a href="../-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 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>
|