-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add api docs for
cffu v1.0.0-Alpha22
- Loading branch information
Showing
171 changed files
with
41,103 additions
and
2 deletions.
There are no files selected for viewing
80 changes: 80 additions & 0 deletions
80
...otlin/1.0.0-Alpha22/cffu-kotlin/io.foldright.cffu.kotlin/accept-either-success-async.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| <!DOCTYPE html> | ||
| <html class="no-js"> | ||
| <head> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> | ||
| <title>acceptEitherSuccessAsync</title> | ||
| <link href="../../images/logo-icon.svg" rel="icon" type="image/svg"> | ||
| <script>var pathToRoot = "../../";</script> | ||
| <script>document.documentElement.classList.replace("no-js","js");</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="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script> | ||
| <script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script> | ||
| <link href="../../styles/style.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"> | ||
| <link href="../../styles/font-jb-sans-auto.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="root"> | ||
| <nav class="navigation" id="navigation-wrapper"> | ||
| <div class="navigation--inner"> | ||
| <div class="navigation-title"> | ||
| <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button> | ||
| <div class="library-name"> | ||
| <a class="library-name--link" href="../../index.html"> | ||
| cffu-kotlin | ||
| </a> | ||
| </div> | ||
| <div class="library-version"> | ||
| </div> | ||
| </div> | ||
| <div class="filter-section" id="filter-section"> | ||
| <button class="platform-tag platform-selector jvm-like" data-active="" data-filter="cffu-kotlin/JVM">JVM</button> | ||
| </div> | ||
| </div> | ||
| <div class="navigation-controls"> | ||
| <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button> | ||
| <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div> | ||
| </div> | ||
| </nav> | ||
| <div id="container"> | ||
| <div class="sidebar" id="leftColumn"> | ||
| <div class="sidebar--inner" id="sideMenu"></div> | ||
| </div> | ||
| <div id="main"> | ||
| <div class="main-content" data-page-type="member" id="content" pageIds="cffu-kotlin::io.foldright.cffu.kotlin//acceptEitherSuccessAsync/java.util.concurrent.CompletableFuture[TypeParam(bounds=[kotlin.Any?])]#java.util.concurrent.CompletionStage[TypeParam(bounds=[kotlin.Any?])]#java.util.function.Consumer[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//-533064318"> | ||
| <div class="breadcrumbs"><a href="../../index.html">cffu-kotlin</a><span class="delimiter">/</span><a href="index.html">io.foldright.cffu.kotlin</a><span class="delimiter">/</span><span class="current">acceptEitherSuccessAsync</span></div> | ||
| <div class="cover "> | ||
| <h1 class="cover"><span>accept</span><wbr></wbr><span>Either</span><wbr></wbr><span>Success</span><wbr></wbr><span><span>Async</span></span></h1> | ||
| </div> | ||
| <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="cffu-kotlin/JVM"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="accept-either-success-async.html">T</a><span class="token operator">> </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html">CompletableFuture</a><span class="token operator"><</span><span class="token keyword">out </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="accept-either-success-async.html"><span class="token function">acceptEitherSuccessAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletionStage.html">CompletionStage</a><span class="token operator"><</span><span class="token keyword">out </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Consumer.html">Consumer</a><span class="token operator"><</span><span class="token keyword">in </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html">CompletableFuture</a><span class="token operator"><</span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Void.html">Void</a><span class="token operator">></span></div><p class="paragraph">Returns a new CompletionStage that, when either given stage success, is executed using this stage's default asynchronous execution facility, with the corresponding result as argument to the supplied action.</p><p class="paragraph">This method is the same as <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html#acceptEitherAsync(java.util.concurrent.CompletionStage[TypeParam(bounds=[kotlin.Any])],java.util.function.Consumer[TypeParam(bounds=[kotlin.Any])])">CompletableFuture.acceptEitherAsync</a> except for the either-<strong>success</strong> behavior(not either-<strong>complete</strong>).</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the new CompletableFuture</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="cffu-kotlin/JVM" data-filterable-set="cffu-kotlin/JVM"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>action</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the action to perform before completing the returned CompletableFuture</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="cffu-kotlin/JVM" data-filterable-set="cffu-kotlin/JVM"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletionStage.html#acceptEitherAsync(java.util.concurrent.CompletionStage[TypeParam(bounds=[kotlin.Any])],java.util.function.Consumer[TypeParam(bounds=[kotlin.Any])])"><span>Completion</span><wbr></wbr><span>Stage.</span><wbr></wbr><span>accept</span><wbr></wbr><span>Either</span><wbr></wbr><span><span>Async</span></span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="accept-either-success-async.html">T</a><span class="token operator">> </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html">CompletableFuture</a><span class="token operator"><</span><span class="token keyword">out </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="accept-either-success-async.html"><span class="token function">acceptEitherSuccessAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletionStage.html">CompletionStage</a><span class="token operator"><</span><span class="token keyword">out </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Consumer.html">Consumer</a><span class="token operator"><</span><span class="token keyword">in </span><a href="accept-either-success-async.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">executor<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/Executor.html">Executor</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html">CompletableFuture</a><span class="token operator"><</span><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Void.html">Void</a><span class="token operator">></span></div><p class="paragraph">Returns a new CompletionStage that, when either given stage success, is executed using the supplied executor, with the corresponding result as argument to the supplied action.</p><p class="paragraph">This method is the same as <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html#acceptEitherAsync(java.util.concurrent.CompletionStage[TypeParam(bounds=[kotlin.Any])],java.util.function.Consumer[TypeParam(bounds=[kotlin.Any])])">CompletableFuture.acceptEitherAsync</a> except for the either-<strong>success</strong> behavior(not either-<strong>complete</strong>).</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the new CompletableFuture</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="cffu-kotlin/JVM" data-filterable-set="cffu-kotlin/JVM"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>action</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the action to perform before completing the returned CompletableFuture</p></div></div></div></div><div class="table-row" data-filterable-current="cffu-kotlin/JVM" data-filterable-set="cffu-kotlin/JVM"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>executor</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the executor to use for asynchronous execution</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="cffu-kotlin/JVM" data-filterable-set="cffu-kotlin/JVM"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletionStage.html#acceptEitherAsync(java.util.concurrent.CompletionStage[TypeParam(bounds=[kotlin.Any])],java.util.function.Consumer[TypeParam(bounds=[kotlin.Any])])"><span>Completion</span><wbr></wbr><span>Stage.</span><wbr></wbr><span>accept</span><wbr></wbr><span>Either</span><wbr></wbr><span><span>Async</span></span></a></div></span></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>© 2024 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> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.