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

…accepting unspecified number of sources. This commit resolves #5412 (#5413)
ReactiveX · Jun 28, 2017 · 4ed9c51 · 4ed9c51
1 parent 5d6ac53
commit 4ed9c51
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 0 deletions.
diff --git a/src/main/java/io/reactivex/Flowable.java b/src/main/java/io/reactivex/Flowable.java
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>

diff --git a/src/main/java/io/reactivex/Observable.java b/src/main/java/io/reactivex/Observable.java
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>