MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/[android]-customizable-handler-holder/index.html
2021-11-05 16:00:14 +00:00

100 lines
12 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>[android]CustomizableHandlerHolder</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/CustomizableHandlerHolder///PointingToDeclaration//-1837788132">
<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">[android]CustomizableHandlerHolder</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/androidMain">android</button></div>
<div id="searchBar"></div>
</div>
</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-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/androidMain"><div class="symbol monospace">class <a href="index.html">CustomizableHandlerHolder</a>&lt;<a href="index.html">I</a> : <a href="index.html">O</a>, <a href="index.html">O</a> : <a href="../[android]-state/index.html">State</a>&gt;(delegateTo: <a href="../[android]-states-handler/index.html">StatesHandler</a>&lt;<a href="index.html">I</a>, <a href="index.html">O</a>&gt;, filter: suspend (<a href="index.html">O</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>) : <a href="../[android]-checkable-handler-holder/index.html">CheckableHandlerHolder</a>&lt;<a href="index.html">I</a>, <a href="index.html">O</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><p class="paragraph">Default realization of <a href="../[android]-states-handler/index.html">StatesHandler</a>. It will incapsulate checking of <a href="../[android]-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="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="-1426844370%2FConstructors%2F-1837788132" anchor-label="CustomizableHandlerHolder" id="-1426844370%2FConstructors%2F-1837788132" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-customizable-handler-holder.html">CustomizableHandlerHolder</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1426844370%2FConstructors%2F-1837788132"></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">android</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/androidMain"><div class="symbol monospace">fun &lt;<a href="index.html">I</a> : <a href="index.html">O</a>, <a href="index.html">O</a> : <a href="../[android]-state/index.html">State</a>&gt; <a href="-customizable-handler-holder.html">CustomizableHandlerHolder</a>(delegateTo: <a href="../[android]-states-handler/index.html">StatesHandler</a>&lt;<a href="index.html">I</a>, <a href="index.html">O</a>&gt;, filter: suspend (<a href="index.html">O</a>) -&gt; <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>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-110026684%2FFunctions%2F-1837788132" anchor-label="checkHandleable" id="-110026684%2FFunctions%2F-1837788132" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="check-handleable.html"><span>check</span><wbr></wbr><span><span>Handleable</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-110026684%2FFunctions%2F-1837788132"></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">android</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"><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/androidMain"><div class="symbol monospace">open suspend override fun <a href="check-handleable.html">checkHandleable</a>(state: <a href="index.html">O</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 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>
<a data-name="1405605635%2FFunctions%2F-1837788132" anchor-label="handleState" id="1405605635%2FFunctions%2F-1837788132" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain">
<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="1405605635%2FFunctions%2F-1837788132"></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">android</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"><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/androidMain"><div class="symbol monospace">open suspend override fun <a href="../[android]-states-machine/index.html">StatesMachine</a>&lt;in <a href="index.html">O</a>&gt;.<a href="handle-state.html">handleState</a>(state: <a href="index.html">I</a>): <a href="index.html">O</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">Calls <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/CustomizableHandlerHolder/delegateTo/#/PointingToDeclaration/">delegateTo</span> method <a href="../[android]-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>
</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>