Skip to content

2.x: Add empty source clauses to javadocs of combineLatest operators … #5413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions src/main/java/io/reactivex/Flowable.java
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,9 @@ public static int bufferSize() {
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -191,6 +194,9 @@ public static <T, R> Flowable<R> combineLatest(Publisher<? extends T>[] sources,
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If there are no source Publishers provided, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -232,6 +238,9 @@ public static <T, R> Flowable<R> combineLatest(Function<? super Object[], ? exte
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -281,6 +290,9 @@ public static <T, R> Flowable<R> combineLatest(Publisher<? extends T>[] sources,
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -323,6 +335,9 @@ public static <T, R> Flowable<R> combineLatest(Iterable<? extends Publisher<? ex
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of source Publishers is empty, the resulting sequence completes immediately without emitting any items and
* without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -370,6 +385,9 @@ public static <T, R> Flowable<R> combineLatest(Iterable<? extends Publisher<? ex
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -413,6 +431,9 @@ public static <T, R> Flowable<R> combineLatestDelayError(Publisher<? extends T>[
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If there are no source Publishers provided, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -456,6 +477,9 @@ public static <T, R> Flowable<R> combineLatestDelayError(Function<? super Object
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If there are no source Publishers provided, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -501,6 +525,9 @@ public static <T, R> Flowable<R> combineLatestDelayError(Function<? super Object
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -552,6 +579,9 @@ public static <T, R> Flowable<R> combineLatestDelayError(Publisher<? extends T>[
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -595,6 +625,9 @@ public static <T, R> Flowable<R> combineLatestDelayError(Iterable<? extends Publ
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of source Publishers is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down
38 changes: 38 additions & 0 deletions src/main/java/io/reactivex/Observable.java
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,10 @@ public static int bufferSize() {
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If there are no ObservableSources provided, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatest.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -217,6 +221,10 @@ public static <T, R> Observable<R> combineLatest(Function<? super Object[], ? ex
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatest.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -255,6 +263,10 @@ public static <T, R> Observable<R> combineLatest(Iterable<? extends ObservableSo
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatest.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -301,6 +313,10 @@ public static <T, R> Observable<R> combineLatest(Iterable<? extends ObservableSo
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatest.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -339,6 +355,10 @@ public static <T, R> Observable<R> combineLatest(ObservableSource<? extends T>[]
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatest.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -829,6 +849,9 @@ public static <T1, T2, T3, T4, T5, T6, T7, T8, T9, R> Observable<R> combineLates
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -869,6 +892,9 @@ public static <T, R> Observable<R> combineLatestDelayError(ObservableSource<? ex
* If any of the sources never produces an item but only terminates (normally or with an error), the
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If there are no ObservableSources provided, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -910,6 +936,10 @@ public static <T, R> Observable<R> combineLatestDelayError(Function<? super Obje
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided array of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatestDelayError.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -958,6 +988,10 @@ public static <T, R> Observable<R> combineLatestDelayError(ObservableSource<? ex
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatestDelayError.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down Expand Up @@ -997,6 +1031,10 @@ public static <T, R> Observable<R> combineLatestDelayError(Iterable<? extends Ob
* resulting sequence terminates immediately (normally or with all the errors accumulated till that point).
* If that input source is also synchronous, other sources after it will not be subscribed to.
* <p>
* If provided iterable of ObservableSources is empty, the resulting sequence completes immediately without emitting
* any items and without any calls to combiner function.
*
* <p>
* <img width="640" height="380" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/combineLatestDelayError.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand Down