@@ -264,6 +264,8 @@ public static Completable concat(Publisher<? extends CompletableSource> sources,
264
264
/**
265
265
* Provides an API (via a cold Completable) that bridges the reactive world with the callback-style world.
266
266
* <p>
267
+ * <img width="640" height="442" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.create.png" alt="">
268
+ * <p>
267
269
* Example:
268
270
* <pre><code>
269
271
* Completable.create(emitter -> {
@@ -305,6 +307,8 @@ public static Completable create(CompletableOnSubscribe source) {
305
307
* Constructs a Completable instance by wrapping the given source callback
306
308
* <strong>without any safeguards; you should manage the lifecycle and response
307
309
* to downstream cancellation/dispose</strong>.
310
+ * <p>
311
+ * <img width="640" height="260" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.unsafeCreate.png" alt="">
308
312
* <dl>
309
313
* <dt><b>Scheduler:</b></dt>
310
314
* <dd>{@code unsafeCreate} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1585,6 +1589,8 @@ public final Completable doFinally(Action onFinally) {
1585
1589
* and providing a new {@code CompletableObserver}, containing the custom operator's intended business logic, that will be
1586
1590
* used in the subscription process going further upstream.
1587
1591
* <p>
1592
+ * <img width="640" height="313" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.lift.png" alt="">
1593
+ * <p>
1588
1594
* Generally, such a new {@code CompletableObserver} will wrap the downstream's {@code CompletableObserver} and forwards the
1589
1595
* {@code onError} and {@code onComplete} events from the upstream directly or according to the
1590
1596
* emission pattern the custom operator's business logic requires. In addition, such operator can intercept the
@@ -1831,6 +1837,8 @@ public final Completable onTerminateDetach() {
1831
1837
1832
1838
/**
1833
1839
* Returns a Completable that repeatedly subscribes to this Completable until cancelled.
1840
+ * <p>
1841
+ * <img width="640" height="373" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.repeat.png" alt="">
1834
1842
* <dl>
1835
1843
* <dt><b>Scheduler:</b></dt>
1836
1844
* <dd>{@code repeat} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1845,6 +1853,8 @@ public final Completable repeat() {
1845
1853
1846
1854
/**
1847
1855
* Returns a Completable that subscribes repeatedly at most the given times to this Completable.
1856
+ * <p>
1857
+ * <img width="640" height="408" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.repeat.n.png" alt="">
1848
1858
* <dl>
1849
1859
* <dt><b>Scheduler:</b></dt>
1850
1860
* <dd>{@code repeat} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1862,6 +1872,8 @@ public final Completable repeat(long times) {
1862
1872
/**
1863
1873
* Returns a Completable that repeatedly subscribes to this Completable so long as the given
1864
1874
* stop supplier returns false.
1875
+ * <p>
1876
+ * <img width="640" height="381" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.repeatUntil.png" alt="">
1865
1877
* <dl>
1866
1878
* <dt><b>Scheduler:</b></dt>
1867
1879
* <dd>{@code repeatUntil} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1879,6 +1891,8 @@ public final Completable repeatUntil(BooleanSupplier stop) {
1879
1891
/**
1880
1892
* Returns a Completable instance that repeats when the Publisher returned by the handler
1881
1893
* emits an item or completes when this Publisher emits a completed event.
1894
+ * <p>
1895
+ * <img width="640" height="586" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.repeatWhen.png" alt="">
1882
1896
* <dl>
1883
1897
* <dt><b>Scheduler:</b></dt>
1884
1898
* <dd>{@code repeatWhen} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1897,6 +1911,8 @@ public final Completable repeatWhen(Function<? super Flowable<Object>, ? extends
1897
1911
1898
1912
/**
1899
1913
* Returns a Completable that retries this Completable as long as it emits an onError event.
1914
+ * <p>
1915
+ * <img width="640" height="368" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retry.png" alt="">
1900
1916
* <dl>
1901
1917
* <dt><b>Scheduler:</b></dt>
1902
1918
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1912,6 +1928,8 @@ public final Completable retry() {
1912
1928
/**
1913
1929
* Returns a Completable that retries this Completable in case of an error as long as the predicate
1914
1930
* returns true.
1931
+ * <p>
1932
+ * <img width="640" height="325" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retry.ff.png" alt="">
1915
1933
* <dl>
1916
1934
* <dt><b>Scheduler:</b></dt>
1917
1935
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1929,6 +1947,8 @@ public final Completable retry(BiPredicate<? super Integer, ? super Throwable> p
1929
1947
/**
1930
1948
* Returns a Completable that when this Completable emits an error, retries at most the given
1931
1949
* number of times before giving up and emitting the last error.
1950
+ * <p>
1951
+ * <img width="640" height="451" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retry.n.png" alt="">
1932
1952
* <dl>
1933
1953
* <dt><b>Scheduler:</b></dt>
1934
1954
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1946,6 +1966,8 @@ public final Completable retry(long times) {
1946
1966
/**
1947
1967
* Returns a Completable that when this Completable emits an error, retries at most times
1948
1968
* or until the predicate returns false, whichever happens first and emitting the last error.
1969
+ * <p>
1970
+ * <img width="640" height="361" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retry.nf.png" alt="">
1949
1971
* <dl>
1950
1972
* <dt><b>Scheduler:</b></dt>
1951
1973
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1968,6 +1990,8 @@ public final Completable retry(long times, Predicate<? super Throwable> predicat
1968
1990
/**
1969
1991
* Returns a Completable that when this Completable emits an error, calls the given predicate with
1970
1992
* the latest exception to decide whether to resubscribe to this or not.
1993
+ * <p>
1994
+ * <img width="640" height="336" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retry.f.png" alt="">
1971
1995
* <dl>
1972
1996
* <dt><b>Scheduler:</b></dt>
1973
1997
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1988,6 +2012,8 @@ public final Completable retry(Predicate<? super Throwable> predicate) {
1988
2012
* that error through a Flowable and the Publisher should signal a value indicating a retry in response
1989
2013
* or a terminal event indicating a termination.
1990
2014
* <p>
2015
+ * <img width="640" height="586" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retryWhen.png" alt="">
2016
+ * <p>
1991
2017
* Note that the inner {@code Publisher} returned by the handler function should signal
1992
2018
* either {@code onNext}, {@code onError} or {@code onComplete} in response to the received
1993
2019
* {@code Throwable} to indicate the operator should retry or terminate. If the upstream to
@@ -2030,6 +2056,8 @@ public final Completable retryWhen(Function<? super Flowable<Throwable>, ? exten
2030
2056
/**
2031
2057
* Returns a Completable which first runs the other Completable
2032
2058
* then this completable if the other completed normally.
2059
+ * <p>
2060
+ * <img width="640" height="437" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.startWith.c.png" alt="">
2033
2061
* <dl>
2034
2062
* <dt><b>Scheduler:</b></dt>
2035
2063
* <dd>{@code startWith} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2048,6 +2076,8 @@ public final Completable startWith(CompletableSource other) {
2048
2076
/**
2049
2077
* Returns an Observable which first delivers the events
2050
2078
* of the other Observable then runs this CompletableConsumable.
2079
+ * <p>
2080
+ * <img width="640" height="289" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.startWith.o.png" alt="">
2051
2081
* <dl>
2052
2082
* <dt><b>Scheduler:</b></dt>
2053
2083
* <dd>{@code startWith} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2066,6 +2096,8 @@ public final <T> Observable<T> startWith(Observable<T> other) {
2066
2096
/**
2067
2097
* Returns a Flowable which first delivers the events
2068
2098
* of the other Publisher then runs this Completable.
2099
+ * <p>
2100
+ * <img width="640" height="250" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.startWith.p.png" alt="">
2069
2101
* <dl>
2070
2102
* <dt><b>Backpressure:</b></dt>
2071
2103
* <dd>The returned {@code Flowable} honors the backpressure of the downstream consumer
@@ -2109,6 +2141,8 @@ public final Completable hide() {
2109
2141
/**
2110
2142
* Subscribes to this CompletableConsumable and returns a Disposable which can be used to cancel
2111
2143
* the subscription.
2144
+ * <p>
2145
+ * <img width="640" height="352" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.subscribe.png" alt="">
2112
2146
* <dl>
2113
2147
* <dt><b>Scheduler:</b></dt>
2114
2148
* <dd>{@code subscribe} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2153,6 +2187,8 @@ public final void subscribe(CompletableObserver s) {
2153
2187
/**
2154
2188
* Subscribes a given CompletableObserver (subclass) to this Completable and returns the given
2155
2189
* CompletableObserver as is.
2190
+ * <p>
2191
+ * <img width="640" height="349" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.subscribeWith.png" alt="">
2156
2192
* <p>Usage example:
2157
2193
* <pre><code>
2158
2194
* Completable source = Completable.complete().delay(1, TimeUnit.SECONDS);
@@ -2183,6 +2219,8 @@ public final <E extends CompletableObserver> E subscribeWith(E observer) {
2183
2219
2184
2220
/**
2185
2221
* Subscribes to this Completable and calls back either the onError or onComplete functions.
2222
+ * <p>
2223
+ * <img width="640" height="352" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.subscribe.ff.png" alt="">
2186
2224
* <dl>
2187
2225
* <dt><b>Scheduler:</b></dt>
2188
2226
* <dd>{@code subscribe} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2207,6 +2245,8 @@ public final Disposable subscribe(final Action onComplete, final Consumer<? supe
2207
2245
* Subscribes to this Completable and calls the given Action when this Completable
2208
2246
* completes normally.
2209
2247
* <p>
2248
+ * <img width="640" height="352" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.subscribe.f.png" alt="">
2249
+ * <p>
2210
2250
* If the Completable emits an error, it is wrapped into an
2211
2251
* {@link io.reactivex.exceptions.OnErrorNotImplementedException OnErrorNotImplementedException}
2212
2252
* and routed to the RxJavaPlugins.onError handler.
@@ -2277,6 +2317,8 @@ public final Completable takeUntil(CompletableSource other) {
2277
2317
/**
2278
2318
* Returns a Completable that runs this Completable and emits a TimeoutException in case
2279
2319
* this Completable doesn't complete within the given time.
2320
+ * <p>
2321
+ * <img width="640" height="348" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.timeout.png" alt="">
2280
2322
* <dl>
2281
2323
* <dt><b>Scheduler:</b></dt>
2282
2324
* <dd>{@code timeout} signals the TimeoutException on the {@code computation} {@link Scheduler}.</dd>
@@ -2295,6 +2337,8 @@ public final Completable timeout(long timeout, TimeUnit unit) {
2295
2337
/**
2296
2338
* Returns a Completable that runs this Completable and switches to the other Completable
2297
2339
* in case this Completable doesn't complete within the given time.
2340
+ * <p>
2341
+ * <img width="640" height="308" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.timeout.c.png" alt="">
2298
2342
* <dl>
2299
2343
* <dt><b>Scheduler:</b></dt>
2300
2344
* <dd>{@code timeout} subscribes to the other CompletableSource on
@@ -2317,6 +2361,8 @@ public final Completable timeout(long timeout, TimeUnit unit, CompletableSource
2317
2361
* Returns a Completable that runs this Completable and emits a TimeoutException in case
2318
2362
* this Completable doesn't complete within the given time while "waiting" on the specified
2319
2363
* Scheduler.
2364
+ * <p>
2365
+ * <img width="640" height="348" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.timeout.s.png" alt="">
2320
2366
* <dl>
2321
2367
* <dt><b>Scheduler:</b></dt>
2322
2368
* <dd>{@code timeout} signals the TimeoutException on the {@link Scheduler} you specify.</dd>
@@ -2337,6 +2383,8 @@ public final Completable timeout(long timeout, TimeUnit unit, Scheduler schedule
2337
2383
* Returns a Completable that runs this Completable and switches to the other Completable
2338
2384
* in case this Completable doesn't complete within the given time while "waiting" on
2339
2385
* the specified scheduler.
2386
+ * <p>
2387
+ * <img width="640" height="308" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.timeout.sc.png" alt="">
2340
2388
* <dl>
2341
2389
* <dt><b>Scheduler:</b></dt>
2342
2390
* <dd>{@code timeout} subscribes to the other CompletableSource on
@@ -2542,6 +2590,8 @@ public final Completable unsubscribeOn(final Scheduler scheduler) {
2542
2590
/**
2543
2591
* Creates a TestObserver and subscribes
2544
2592
* it to this Completable.
2593
+ * <p>
2594
+ * <img width="640" height="458" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.test.png" alt="">
2545
2595
* <dl>
2546
2596
* <dt><b>Scheduler:</b></dt>
2547
2597
* <dd>{@code test} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2561,6 +2611,8 @@ public final TestObserver<Void> test() {
2561
2611
* Creates a TestObserver optionally in cancelled state, then subscribes it to this Completable.
2562
2612
* @param cancelled if true, the TestObserver will be cancelled before subscribing to this
2563
2613
* Completable.
2614
+ * <p>
2615
+ * <img width="640" height="499" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.test.b.png" alt="">
2564
2616
* <dl>
2565
2617
* <dt><b>Scheduler:</b></dt>
2566
2618
* <dd>{@code test} does not operate by default on a particular {@link Scheduler}.</dd>
0 commit comments