Skip to content
This repository was archived by the owner on Feb 25, 2024. It is now read-only.

Commit 0e568c6

Browse files
committed
update Javadoc
1 parent b33683e commit 0e568c6

21 files changed

+908
-90
lines changed

docs/apidocs/allclasses-frame.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>All Classes (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
@@ -15,6 +15,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
1515
<ul>
1616
<li><a href="java9/util/concurrent/CompletableFuture.html" title="class in java9.util.concurrent" target="classFrame">CompletableFuture</a></li>
1717
<li><a href="java9/util/concurrent/CompletableFuture.AsynchronousCompletionTask.html" title="interface in java9.util.concurrent" target="classFrame"><span class="interfaceName">CompletableFuture.AsynchronousCompletionTask</span></a></li>
18+
<li><a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent" target="classFrame">CompletionException</a></li>
1819
<li><a href="java9/util/concurrent/CompletionStage.html" title="interface in java9.util.concurrent" target="classFrame"><span class="interfaceName">CompletionStage</span></a></li>
1920
</ul>
2021
</div>

docs/apidocs/allclasses-noframe.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>All Classes (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
@@ -15,6 +15,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
1515
<ul>
1616
<li><a href="java9/util/concurrent/CompletableFuture.html" title="class in java9.util.concurrent">CompletableFuture</a></li>
1717
<li><a href="java9/util/concurrent/CompletableFuture.AsynchronousCompletionTask.html" title="interface in java9.util.concurrent"><span class="interfaceName">CompletableFuture.AsynchronousCompletionTask</span></a></li>
18+
<li><a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></li>
1819
<li><a href="java9/util/concurrent/CompletionStage.html" title="interface in java9.util.concurrent"><span class="interfaceName">CompletionStage</span></a></li>
1920
</ul>
2021
</div>

docs/apidocs/constant-values.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:15 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Constant Field Values (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>Constant Field Values (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Constant Field Values (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="Constant Field Values (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -119,6 +119,6 @@ <h2 title="Contents">Contents</h2>
119119
<!-- -->
120120
</a></div>
121121
<!-- ======== END OF BOTTOM NAVBAR ======= -->
122-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
122+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
123123
</body>
124124
</html>

docs/apidocs/deprecated-list.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Deprecated List (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>Deprecated List (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Deprecated List (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="Deprecated List (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -119,6 +119,6 @@ <h2 title="Contents">Contents</h2>
119119
<!-- -->
120120
</a></div>
121121
<!-- ======== END OF BOTTOM NAVBAR ======= -->
122-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
122+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
123123
</body>
124124
</html>

docs/apidocs/help-doc.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>API Help (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>API Help (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="API Help (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="API Help (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -220,6 +220,6 @@ <h2>Constant Field Values</h2>
220220
<!-- -->
221221
</a></div>
222222
<!-- ======== END OF BOTTOM NAVBAR ======= -->
223-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
223+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
224224
</body>
225225
</html>

docs/apidocs/index-all.html

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Index (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>Index (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Index (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="Index (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -200,6 +200,29 @@ <h2 class="title">C</h2>
200200
<div class="block">Completes this CompletableFuture with the given value if not
201201
otherwise completed before the given timeout.</div>
202202
</dd>
203+
<dt><a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent"><span class="typeNameLink">CompletionException</span></a> - Exception in <a href="java9/util/concurrent/package-summary.html">java9.util.concurrent</a></dt>
204+
<dd>
205+
<div class="block">Exception thrown when an error or other exception is encountered
206+
in the course of completing a result or task.</div>
207+
</dd>
208+
<dt><span class="memberNameLink"><a href="java9/util/concurrent/CompletionException.html#CompletionException--">CompletionException()</a></span> - Constructor for exception java9.util.concurrent.<a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></dt>
209+
<dd>
210+
<div class="block">Constructs a <code>CompletionException</code> with no detail message.</div>
211+
</dd>
212+
<dt><span class="memberNameLink"><a href="java9/util/concurrent/CompletionException.html#CompletionException-java.lang.String-">CompletionException(String)</a></span> - Constructor for exception java9.util.concurrent.<a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></dt>
213+
<dd>
214+
<div class="block">Constructs a <code>CompletionException</code> with the specified detail
215+
message.</div>
216+
</dd>
217+
<dt><span class="memberNameLink"><a href="java9/util/concurrent/CompletionException.html#CompletionException-java.lang.String-java.lang.Throwable-">CompletionException(String, Throwable)</a></span> - Constructor for exception java9.util.concurrent.<a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></dt>
218+
<dd>
219+
<div class="block">Constructs a <code>CompletionException</code> with the specified detail
220+
message and cause.</div>
221+
</dd>
222+
<dt><span class="memberNameLink"><a href="java9/util/concurrent/CompletionException.html#CompletionException-java.lang.Throwable-">CompletionException(Throwable)</a></span> - Constructor for exception java9.util.concurrent.<a href="java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></dt>
223+
<dd>
224+
<div class="block">Constructs a <code>CompletionException</code> with the specified cause.</div>
225+
</dd>
203226
<dt><a href="java9/util/concurrent/CompletionStage.html" title="interface in java9.util.concurrent"><span class="typeNameLink">CompletionStage</span></a>&lt;<a href="java9/util/concurrent/CompletionStage.html" title="type parameter in CompletionStage">T</a>&gt; - Interface in <a href="java9/util/concurrent/package-summary.html">java9.util.concurrent</a></dt>
204227
<dd>
205228
<div class="block">A stage of a possibly asynchronous computation, that performs an
@@ -737,6 +760,6 @@ <h2 class="title">W</h2>
737760
<!-- -->
738761
</a></div>
739762
<!-- ======== END OF BOTTOM NAVBAR ======= -->
740-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
763+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
741764
</body>
742765
</html>

docs/apidocs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:16 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>net.sourceforge.streamsupport:android-retrofuture 1.6.0 API</title>
7+
<title>net.sourceforge.streamsupport:android-retrofuture 1.6.1 API</title>
88
<script type="text/javascript">
99
targetPage = "" + window.location.search;
1010
if (targetPage != "" && targetPage != "undefined")

docs/apidocs/java9/util/concurrent/CompletableFuture.AsynchronousCompletionTask.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:15 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>CompletableFuture.AsynchronousCompletionTask (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>CompletableFuture.AsynchronousCompletionTask (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="CompletableFuture.AsynchronousCompletionTask (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="CompletableFuture.AsynchronousCompletionTask (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -44,7 +44,7 @@
4444
<div class="subNav">
4545
<ul class="navList">
4646
<li><a href="../../../java9/util/concurrent/CompletableFuture.html" title="class in java9.util.concurrent"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
47-
<li><a href="../../../java9/util/concurrent/CompletionStage.html" title="interface in java9.util.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
47+
<li><a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
4848
</ul>
4949
<ul class="navList">
5050
<li><a href="../../../index.html?java9/util/concurrent/CompletableFuture.AsynchronousCompletionTask.html" target="_top">Frames</a></li>
@@ -133,7 +133,7 @@ <h2 title="Interface CompletableFuture.AsynchronousCompletionTask" class="title"
133133
<div class="subNav">
134134
<ul class="navList">
135135
<li><a href="../../../java9/util/concurrent/CompletableFuture.html" title="class in java9.util.concurrent"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
136-
<li><a href="../../../java9/util/concurrent/CompletionStage.html" title="interface in java9.util.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
136+
<li><a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
137137
</ul>
138138
<ul class="navList">
139139
<li><a href="../../../index.html?java9/util/concurrent/CompletableFuture.AsynchronousCompletionTask.html" target="_top">Frames</a></li>
@@ -173,6 +173,6 @@ <h2 title="Interface CompletableFuture.AsynchronousCompletionTask" class="title"
173173
<!-- -->
174174
</a></div>
175175
<!-- ======== END OF BOTTOM NAVBAR ======= -->
176-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
176+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
177177
</body>
178178
</html>

docs/apidocs/java9/util/concurrent/CompletableFuture.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_51) on Sun Dec 10 16:09:15 CET 2017 -->
5+
<!-- Generated by javadoc (1.8.0_51) on Sun Jan 28 22:17:17 CET 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>CompletableFuture (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)</title>
8-
<meta name="date" content="2017-12-10">
7+
<title>CompletableFuture (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)</title>
8+
<meta name="date" content="2018-01-28">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="CompletableFuture (net.sourceforge.streamsupport:android-retrofuture 1.6.0 API)";
16+
parent.document.title="CompletableFuture (net.sourceforge.streamsupport:android-retrofuture 1.6.1 API)";
1717
}
1818
}
1919
catch(err) {
@@ -1106,14 +1106,14 @@ <h4>join</h4>
11061106
conform with the use of common functional forms, if a
11071107
computation involved in the completion of this
11081108
CompletableFuture threw an exception, this method throws an
1109-
(unchecked) <code>CompletionException</code> with the underlying
1109+
(unchecked) <a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent"><code>CompletionException</code></a> with the underlying
11101110
exception as its cause.</div>
11111111
<dl>
11121112
<dt><span class="returnLabel">Returns:</span></dt>
11131113
<dd>the result value</dd>
11141114
<dt><span class="throwsLabel">Throws:</span></dt>
11151115
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CancellationException.html?is-external=true" title="class or interface in java.util.concurrent">CancellationException</a></code> - if the computation was cancelled</dd>
1116-
<dd><code>CompletionException</code> - if this future completed
1116+
<dd><code><a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></code> - if this future completed
11171117
exceptionally or a completion computation threw an exception</dd>
11181118
</dl>
11191119
</li>
@@ -1136,7 +1136,7 @@ <h4>getNow</h4>
11361136
<dd>the result value, if completed, else the given valueIfAbsent</dd>
11371137
<dt><span class="throwsLabel">Throws:</span></dt>
11381138
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CancellationException.html?is-external=true" title="class or interface in java.util.concurrent">CancellationException</a></code> - if the computation was cancelled</dd>
1139-
<dd><code>CompletionException</code> - if this future completed
1139+
<dd><code><a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent">CompletionException</a></code> - if this future completed
11401140
exceptionally or a completion computation threw an exception</dd>
11411141
</dl>
11421142
</li>
@@ -2368,7 +2368,7 @@ <h4>cancel</h4>
23682368
<div class="block">If not already completed, completes this CompletableFuture with
23692369
a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CancellationException.html?is-external=true" title="class or interface in java.util.concurrent"><code>CancellationException</code></a>. Dependent CompletableFutures
23702370
that have not already completed will also complete
2371-
exceptionally, with a <code>CompletionException</code> caused by
2371+
exceptionally, with a <a href="../../../java9/util/concurrent/CompletionException.html" title="class in java9.util.concurrent"><code>CompletionException</code></a> caused by
23722372
this <code>CancellationException</code>.</div>
23732373
<dl>
23742374
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -2872,6 +2872,6 @@ <h4>failedStage</h4>
28722872
<!-- -->
28732873
</a></div>
28742874
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2875-
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
2875+
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
28762876
</body>
28772877
</html>

0 commit comments

Comments
 (0)