@@ -474,7 +474,7 @@ public void call(CompletableSubscriber s) {
474
474
/**
475
475
* Returns a Completable instance that runs the given Action0 for each subscriber and
476
476
* emits either an unchecked exception or simply completes.
477
- * @param run the runnable to run for each subscriber
477
+ * @param action the Action0 to run for each subscriber
478
478
* @return the new Completable instance
479
479
* @throws NullPointerException if run is null
480
480
*/
@@ -725,6 +725,7 @@ public static Completable mergeDelayError(Observable<? extends Completable> sour
725
725
* observable or any of the inner Completables until all of
726
726
* them terminate in a way or another.
727
727
* @param sources the sequence of Completables
728
+ * @param maxConcurrency the maximum number of simultaneous subscriptions to the source Completables.
728
729
* @return the new Completable instance
729
730
* @throws NullPointerException if sources is null
730
731
*/
@@ -764,10 +765,11 @@ public static Completable timer(long delay, TimeUnit unit) {
764
765
}
765
766
766
767
/**
767
- * Returns a Completable instance that fires its onComplete event after the given delay elapsed
768
+ * Returns a Completable instance that fires its onCompleted event after the given delay elapsed
768
769
* by using the supplied scheduler.
769
770
* @param delay the delay time
770
771
* @param unit the delay unit
772
+ * @param scheduler the scheduler to use to emit the onCompleted event
771
773
* @return the new Completable instance
772
774
*/
773
775
public static Completable timer (final long delay , final TimeUnit unit , final Scheduler scheduler ) {
@@ -813,6 +815,7 @@ static NullPointerException toNpe(Throwable ex) {
813
815
* <p>
814
816
* This overload performs an eager unsubscription before the terminal event is emitted.
815
817
*
818
+ * @param <R> the resource type
816
819
* @param resourceFunc0 the supplier that returns a resource to be managed.
817
820
* @param completableFunc1 the function that given a resource returns a Completable instance that will be subscribed to
818
821
* @param disposer the consumer that disposes the resource created by the resource supplier
@@ -832,6 +835,7 @@ public static <R> Completable using(Func0<R> resourceFunc0,
832
835
* If this overload performs a lazy unsubscription after the terminal event is emitted.
833
836
* Exceptions thrown at this time will be delivered to RxJavaPlugins only.
834
837
*
838
+ * @param <R> the resource type
835
839
* @param resourceFunc0 the supplier that returns a resource to be managed
836
840
* @param completableFunc1 the function that given a resource returns a non-null
837
841
* Completable instance that will be subscribed to
@@ -1108,6 +1112,7 @@ public final Completable compose(CompletableTransformer transformer) {
1108
1112
* propagated to the downstream subscriber and will result in skipping the subscription of the
1109
1113
* Observable.
1110
1114
*
1115
+ * @param <T> the value type of the next Observable
1111
1116
* @param next the Observable to subscribe after this Completable is completed, not null
1112
1117
* @return Observable that composes this Completable and next
1113
1118
* @throws NullPointerException if next is null
@@ -1127,6 +1132,7 @@ public final <T> Observable<T> andThen(Observable<T> next) {
1127
1132
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
1128
1133
* </dl>
1129
1134
*
1135
+ * @param <T> the value type of the next Single
1130
1136
* @param next the Single to subscribe after this Completable is completed, not null
1131
1137
* @return Single that composes this Completable and next
1132
1138
*/
@@ -1421,6 +1427,7 @@ public final Completable endWith(Completable other) {
1421
1427
/**
1422
1428
* Returns an Observable that first runs this Completable instance and
1423
1429
* resumes with the given next Observable.
1430
+ * @param <T> the value type of the next Observable
1424
1431
* @param next the next Observable to continue
1425
1432
* @return the new Observable instance
1426
1433
* @deprecated Use {@link #andThen(rx.Observable)} instead.
@@ -1485,6 +1492,8 @@ public void onSubscribe(Subscription d) {
1485
1492
/**
1486
1493
* Subscribes to this Completable instance and blocks until it terminates or the specified timeout
1487
1494
* elapses, then returns null for normal termination or the emitted exception if any.
1495
+ * @param timeout the time amount to wait for the terminal event
1496
+ * @param unit the time unit of the timeout parameter
1488
1497
* @return the throwable if this terminated with an error, null otherwise
1489
1498
* @throws RuntimeException that wraps an InterruptedException if the wait is interrupted or
1490
1499
* TimeoutException if the specified timeout elapsed before it
@@ -1845,6 +1854,7 @@ public final Completable startWith(Completable other) {
1845
1854
/**
1846
1855
* Returns an Observable which first delivers the events
1847
1856
* of the other Observable then runs this Completable.
1857
+ * @param <T> the value type of the starting other Observable
1848
1858
* @param other the other Observable to run first
1849
1859
* @return the new Observable instance
1850
1860
* @throws NullPointerException if other is null
@@ -2201,6 +2211,7 @@ public final Completable timeout0(long timeout, TimeUnit unit, Scheduler schedul
2201
2211
2202
2212
/**
2203
2213
* Allows fluent conversion to another type via a function callback.
2214
+ * @param <U> the output type as determined by the converter function
2204
2215
* @param converter the function called with this which should return some other value.
2205
2216
* @return the converted value
2206
2217
* @throws NullPointerException if converter is null
@@ -2212,6 +2223,7 @@ public final <U> U to(Func1<? super Completable, U> converter) {
2212
2223
/**
2213
2224
* Returns an Observable which when subscribed to subscribes to this Completable and
2214
2225
* relays the terminal events to the subscriber.
2226
+ * @param <T> the target type of the Observable
2215
2227
* @return the new Observable created
2216
2228
*/
2217
2229
public final <T > Observable <T > toObservable () {
@@ -2226,6 +2238,7 @@ public void call(Subscriber<? super T> s) {
2226
2238
/**
2227
2239
* Converts this Completable into a Single which when this Completable completes normally,
2228
2240
* calls the given supplier and emits its returned value through onSuccess.
2241
+ * @param <T> the value type of the resulting Single
2229
2242
* @param completionValueFunc0 the value supplier called when this Completable completes normally
2230
2243
* @return the new Single instance
2231
2244
* @throws NullPointerException if completionValueFunc0 is null
@@ -2273,6 +2286,7 @@ public void onSubscribe(Subscription d) {
2273
2286
/**
2274
2287
* Converts this Completable into a Single which when this Completable completes normally,
2275
2288
* emits the given value through onSuccess.
2289
+ * @param <T> the value type of the resulting Single
2276
2290
* @param completionValue the value to emit when this Completable completes normally
2277
2291
* @return the new Single instance
2278
2292
* @throws NullPointerException if completionValue is null
0 commit comments