Skip to content

Commit

Permalink
add api docs for v0.9.8
Browse files Browse the repository at this point in the history
  • Loading branch information
@oldratlee
oldratlee committed Apr 10, 2024
1 parent 19922f2 commit 34327c1
Show file tree
Hide file tree
Showing 147 changed files with 23,547 additions and 2 deletions.
126 changes: 126 additions & 0 deletions apidocs/0.9.8/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) on Wed Aug 09 21:07:31 CST 2023 -->
<title>All Classes and Interfaces (CompletableFuture-Fu(cffu) 0.9.8 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-08-09">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enums</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/Cffu.html" title="class in io.foldright.cffu">Cffu</a>&lt;<a href="io/foldright/cffu/Cffu.html" title="type parameter in Cffu">T</a>&gt;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class <a href="io/foldright/cffu/Cffu.html" title="class in io.foldright.cffu"><code>Cffu</code></a> is the equivalent class to <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>,
contains the equivalent instance methods of <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletionStage.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletionStage</code></a> and <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/CffuFactory.html" title="class in io.foldright.cffu">CffuFactory</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class <a href="io/foldright/cffu/CffuFactory.html" title="class in io.foldright.cffu"><code>CffuFactory</code></a> is equivalent to <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>,
contains the static factory methods of <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/CffuFactoryBuilder.html" title="class in io.foldright.cffu">CffuFactoryBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="io/foldright/cffu/CffuFactoryBuilder.html" title="class in io.foldright.cffu"><code>CffuFactoryBuilder</code></a> is the builder of <a href="io/foldright/cffu/CffuFactory.html" title="class in io.foldright.cffu"><code>CffuFactory</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="io/foldright/cffu/CffuState.html" title="enum in io.foldright.cffu">CffuState</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Same as <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/Future.State.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future.State</code></a>, existed for
java version compatibility(<a href="io/foldright/cffu/Cffu.html#cffuState()"><code>cffuState</code></a> to <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/Future.html#state()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.state()</code></a>).</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/ttl/CffuTtlExecutorWrapperProvider.html" title="class in io.foldright.cffu.ttl">CffuTtlExecutorWrapperProvider</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Cffu executor wrapper provider(<a href="io/foldright/cffu/spi/ExecutorWrapperProvider.html" title="interface in io.foldright.cffu.spi"><code>ExecutorWrapperProvider</code></a>) SPI implementation for
<a href="https://github.com/alibaba/transmittable-thread-local">📌 TransmittableThreadLocal (TTL)</a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/CompletableFutureUtils.html" title="class in io.foldright.cffu">CompletableFutureUtils</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class contains the enhanced methods for <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/foldright/cffu/spi/ExecutorWrapperProvider.html" title="interface in io.foldright.cffu.spi">ExecutorWrapperProvider</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">An SPI for wrapping the executor when <a href="io/foldright/cffu/CffuFactoryBuilder.html" title="class in io.foldright.cffu"><code>CffuFactoryBuilder</code></a>
<a href="io/foldright/cffu/CffuFactoryBuilder.html#build()"><code>build</code></a> <a href="io/foldright/cffu/CffuFactory.html" title="class in io.foldright.cffu"><code>CffuFactory</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/foldright/cffu/NoCfsProvidedException.html" title="class in io.foldright.cffu">NoCfsProvidedException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">Exception indicates that NO cfs(<a href="io/foldright/cffu/Cffu.html" title="class in io.foldright.cffu"><code>Cffu</code></a> / <a href="https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a>) are provided
for methods require cf arguments.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/tuple/Tuple2.html" title="class in io.foldright.cffu.tuple">Tuple2</a>&lt;<a href="io/foldright/cffu/tuple/Tuple2.html" title="type parameter in Tuple2">T1</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple2.html" title="type parameter in Tuple2">T2</a>&gt;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Tuple2(aka Pair).</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/tuple/Tuple3.html" title="class in io.foldright.cffu.tuple">Tuple3</a>&lt;<a href="io/foldright/cffu/tuple/Tuple3.html" title="type parameter in Tuple3">T1</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple3.html" title="type parameter in Tuple3">T2</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple3.html" title="type parameter in Tuple3">T3</a>&gt;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Tuple3(aka Triple).</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/tuple/Tuple4.html" title="class in io.foldright.cffu.tuple">Tuple4</a>&lt;<a href="io/foldright/cffu/tuple/Tuple4.html" title="type parameter in Tuple4">T1</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple4.html" title="type parameter in Tuple4">T2</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple4.html" title="type parameter in Tuple4">T3</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple4.html" title="type parameter in Tuple4">T4</a>&gt;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Tuple4, contains 4 elements.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/cffu/tuple/Tuple5.html" title="class in io.foldright.cffu.tuple">Tuple5</a>&lt;<a href="io/foldright/cffu/tuple/Tuple5.html" title="type parameter in Tuple5">T1</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple5.html" title="type parameter in Tuple5">T2</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple5.html" title="type parameter in Tuple5">T3</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple5.html" title="type parameter in Tuple5">T4</a>,<wbr><a href="io/foldright/cffu/tuple/Tuple5.html" title="type parameter in Tuple5">T5</a>&gt;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Tuple5, contains 5 elements.</div>
</div>
</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://foldright.io">FoldRight</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
85 changes: 85 additions & 0 deletions apidocs/0.9.8/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) on Wed Aug 09 21:07:31 CST 2023 -->
<title>All Packages (CompletableFuture-Fu(cffu) 0.9.8 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-08-09">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-packages-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-packages">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</div>
<div class="caption"><span>Package Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="io/foldright/cffu/package-summary.html">io.foldright.cffu</a></div>
<div class="col-last even-row-color">
<div class="block">A tiny sidekick library for CompletableFuture to improve user experience and reduce misuse.</div>
</div>
<div class="col-first odd-row-color"><a href="io/foldright/cffu/spi/package-summary.html">io.foldright.cffu.spi</a></div>
<div class="col-last odd-row-color">
<div class="block">Cffu <code>SPI</code> interfaces.</div>
</div>
<div class="col-first even-row-color"><a href="io/foldright/cffu/ttl/package-summary.html">io.foldright.cffu.ttl</a></div>
<div class="col-last even-row-color">
<div class="block">Cffu executor wrapper provider(<a href="io/foldright/cffu/spi/ExecutorWrapperProvider.html" title="interface in io.foldright.cffu.spi"><code>ExecutorWrapperProvider</code></a>) SPI implementation for
<a href="https://github.com/alibaba/transmittable-thread-local">📌 TransmittableThreadLocal (TTL)</a>.</div>
</div>
<div class="col-first odd-row-color"><a href="io/foldright/cffu/tuple/package-summary.html">io.foldright.cffu.tuple</a></div>
<div class="col-last odd-row-color">
<div class="block">the <code>Tuple</code> util classes for <code>Cffu</code> use.</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://foldright.io">FoldRight</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
33 changes: 33 additions & 0 deletions apidocs/0.9.8/copy.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions apidocs/0.9.8/element-list
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
io.foldright.cffu
io.foldright.cffu.spi
io.foldright.cffu.ttl
io.foldright.cffu.tuple
Loading

0 comments on commit 34327c1

Please sign in to comment.