Skip to content

Commit 65d0739

Browse files
authored
3.x: Fix fromCompletionStage javadoc (#7508)
1 parent 47d413d commit 65d0739

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

src/main/java/io/reactivex/rxjava3/core/Completable.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,6 +601,7 @@ public static Completable fromCallable(@NonNull Callable<?> callable) {
601601
* @param future the {@code Future} to react to
602602
* @return the new {@code Completable} instance
603603
* @throws NullPointerException if {@code future} is {@code null}
604+
* @see #fromCompletionStage(CompletionStage)
604605
*/
605606
@CheckReturnValue
606607
@NonNull
@@ -3410,7 +3411,7 @@ public final TestObserver<Void> test(boolean dispose) {
34103411
* <img width="640" height="262" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/fromCompletionStage.c.png" alt="">
34113412
* <p>
34123413
* Note that the operator takes an already instantiated, running or terminated {@code CompletionStage}.
3413-
* If the optional is to be created per consumer upon subscription, use {@link #defer(Supplier)}
3414+
* If the {@code CompletionStage} is to be created per consumer upon subscription, use {@link #defer(Supplier)}
34143415
* around {@code fromCompletionStage}:
34153416
* <pre><code>
34163417
* Maybe.defer(() -&gt; Completable.fromCompletionStage(createCompletionStage()));

src/main/java/io/reactivex/rxjava3/core/Flowable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20033,7 +20033,7 @@ public final TestSubscriber<T> test(long initialRequest, boolean cancel) { // No
2003320033
* <img width="640" height="262" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/fromCompletionStage.f.png" alt="">
2003420034
* <p>
2003520035
* Note that the operator takes an already instantiated, running or terminated {@code CompletionStage}.
20036-
* If the optional is to be created per consumer upon subscription, use {@link #defer(Supplier)}
20036+
* If the {@code CompletionStage} is to be created per consumer upon subscription, use {@link #defer(Supplier)}
2003720037
* around {@code fromCompletionStage}:
2003820038
* <pre><code>
2003920039
* Flowable.defer(() -&gt; Flowable.fromCompletionStage(createCompletionStage()));

src/main/java/io/reactivex/rxjava3/core/Maybe.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1109,6 +1109,7 @@ public abstract class Maybe<@NonNull T> implements MaybeSource<T> {
11091109
* @return the new {@code Maybe} instance
11101110
* @throws NullPointerException if {@code future} is {@code null}
11111111
* @see <a href="http://reactivex.io/documentation/operators/from.html">ReactiveX operators documentation: From</a>
1112+
* @see #fromCompletionStage(CompletionStage)
11121113
*/
11131114
@CheckReturnValue
11141115
@NonNull
@@ -1147,6 +1148,7 @@ public abstract class Maybe<@NonNull T> implements MaybeSource<T> {
11471148
* @return the new {@code Maybe} instance
11481149
* @throws NullPointerException if {@code future} or {@code unit} is {@code null}
11491150
* @see <a href="http://reactivex.io/documentation/operators/from.html">ReactiveX operators documentation: From</a>
1151+
* @see #fromCompletionStage(CompletionStage)
11501152
*/
11511153
@CheckReturnValue
11521154
@NonNull
@@ -6145,7 +6147,7 @@ public final TestObserver<T> test(boolean dispose) {
61456147
* <img width="640" height="262" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/fromCompletionStage.s.png" alt="">
61466148
* <p>
61476149
* Note that the operator takes an already instantiated, running or terminated {@code CompletionStage}.
6148-
* If the optional is to be created per consumer upon subscription, use {@link #defer(Supplier)}
6150+
* If the {@code CompletionStage} is to be created per consumer upon subscription, use {@link #defer(Supplier)}
61496151
* around {@code fromCompletionStage}:
61506152
* <pre><code>
61516153
* Maybe.defer(() -&gt; Maybe.fromCompletionStage(createCompletionStage()));

src/main/java/io/reactivex/rxjava3/core/Observable.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2020,6 +2020,7 @@ public static int bufferSize() {
20202020
* @return the new {@code Observable} instance
20212021
* @throws NullPointerException if {@code future} is {@code null}
20222022
* @see <a href="http://reactivex.io/documentation/operators/from.html">ReactiveX operators documentation: From</a>
2023+
* @see #fromCompletionStage(CompletionStage)
20232024
*/
20242025
@CheckReturnValue
20252026
@NonNull
@@ -2062,6 +2063,7 @@ public static int bufferSize() {
20622063
* @return the new {@code Observable} instance
20632064
* @throws NullPointerException if {@code future} or {@code unit} is {@code null}
20642065
* @see <a href="http://reactivex.io/documentation/operators/from.html">ReactiveX operators documentation: From</a>
2066+
* @see #fromCompletionStage(CompletionStage)
20652067
*/
20662068
@CheckReturnValue
20672069
@NonNull
@@ -16776,7 +16778,7 @@ public final TestObserver<T> test(boolean dispose) { // NoPMD
1677616778
* <img width="640" height="262" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/fromCompletionStage.o.png" alt="">
1677716779
* <p>
1677816780
* Note that the operator takes an already instantiated, running or terminated {@code CompletionStage}.
16779-
* If the optional is to be created per consumer upon subscription, use {@link #defer(Supplier)}
16781+
* If the {@code CompletionStage} is to be created per consumer upon subscription, use {@link #defer(Supplier)}
1678016782
* around {@code fromCompletionStage}:
1678116783
* <pre><code>
1678216784
* Observable.defer(() -&gt; Observable.fromCompletionStage(createCompletionStage()));

src/main/java/io/reactivex/rxjava3/core/Single.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5598,7 +5598,7 @@ private static <T> Single<T> toSingle(@NonNull Flowable<T> source) {
55985598
* <img width="640" height="262" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/fromCompletionStage.s.png" alt="">
55995599
* <p>
56005600
* Note that the operator takes an already instantiated, running or terminated {@code CompletionStage}.
5601-
* If the optional is to be created per consumer upon subscription, use {@link #defer(Supplier)}
5601+
* If the {@code CompletionStage} is to be created per consumer upon subscription, use {@link #defer(Supplier)}
56025602
* around {@code fromCompletionStage}:
56035603
* <pre><code>
56045604
* Single.defer(() -&gt; Single.fromCompletionStage(createCompletionStage()));

0 commit comments

Comments
 (0)