Skip to content

Commit f4a18fd

Browse files
authored
2.x: Final set of missing Completable marbles (#6101)
1 parent ca5119c commit f4a18fd

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,8 @@ public static Completable concat(Publisher<? extends CompletableSource> sources,
264264
/**
265265
* Provides an API (via a cold Completable) that bridges the reactive world with the callback-style world.
266266
* <p>
267+
* <img width="640" height="442" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.create.png" alt="">
268+
* <p>
267269
* Example:
268270
* <pre><code>
269271
* Completable.create(emitter -&gt; {
@@ -305,6 +307,8 @@ public static Completable create(CompletableOnSubscribe source) {
305307
* Constructs a Completable instance by wrapping the given source callback
306308
* <strong>without any safeguards; you should manage the lifecycle and response
307309
* 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="">
308312
* <dl>
309313
* <dt><b>Scheduler:</b></dt>
310314
* <dd>{@code unsafeCreate} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1585,6 +1589,8 @@ public final Completable doFinally(Action onFinally) {
15851589
* and providing a new {@code CompletableObserver}, containing the custom operator's intended business logic, that will be
15861590
* used in the subscription process going further upstream.
15871591
* <p>
1592+
* <img width="640" height="313" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.lift.png" alt="">
1593+
* <p>
15881594
* Generally, such a new {@code CompletableObserver} will wrap the downstream's {@code CompletableObserver} and forwards the
15891595
* {@code onError} and {@code onComplete} events from the upstream directly or according to the
15901596
* emission pattern the custom operator's business logic requires. In addition, such operator can intercept the
@@ -1831,6 +1837,8 @@ public final Completable onTerminateDetach() {
18311837

18321838
/**
18331839
* 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="">
18341842
* <dl>
18351843
* <dt><b>Scheduler:</b></dt>
18361844
* <dd>{@code repeat} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1845,6 +1853,8 @@ public final Completable repeat() {
18451853

18461854
/**
18471855
* 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="">
18481858
* <dl>
18491859
* <dt><b>Scheduler:</b></dt>
18501860
* <dd>{@code repeat} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1862,6 +1872,8 @@ public final Completable repeat(long times) {
18621872
/**
18631873
* Returns a Completable that repeatedly subscribes to this Completable so long as the given
18641874
* 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="">
18651877
* <dl>
18661878
* <dt><b>Scheduler:</b></dt>
18671879
* <dd>{@code repeatUntil} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1879,6 +1891,8 @@ public final Completable repeatUntil(BooleanSupplier stop) {
18791891
/**
18801892
* Returns a Completable instance that repeats when the Publisher returned by the handler
18811893
* 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="">
18821896
* <dl>
18831897
* <dt><b>Scheduler:</b></dt>
18841898
* <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
18971911

18981912
/**
18991913
* 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="">
19001916
* <dl>
19011917
* <dt><b>Scheduler:</b></dt>
19021918
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1912,6 +1928,8 @@ public final Completable retry() {
19121928
/**
19131929
* Returns a Completable that retries this Completable in case of an error as long as the predicate
19141930
* 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="">
19151933
* <dl>
19161934
* <dt><b>Scheduler:</b></dt>
19171935
* <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
19291947
/**
19301948
* Returns a Completable that when this Completable emits an error, retries at most the given
19311949
* 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="">
19321952
* <dl>
19331953
* <dt><b>Scheduler:</b></dt>
19341954
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1946,6 +1966,8 @@ public final Completable retry(long times) {
19461966
/**
19471967
* Returns a Completable that when this Completable emits an error, retries at most times
19481968
* 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="">
19491971
* <dl>
19501972
* <dt><b>Scheduler:</b></dt>
19511973
* <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
19681990
/**
19691991
* Returns a Completable that when this Completable emits an error, calls the given predicate with
19701992
* 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="">
19711995
* <dl>
19721996
* <dt><b>Scheduler:</b></dt>
19731997
* <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) {
19882012
* that error through a Flowable and the Publisher should signal a value indicating a retry in response
19892013
* or a terminal event indicating a termination.
19902014
* <p>
2015+
* <img width="640" height="586" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.retryWhen.png" alt="">
2016+
* <p>
19912017
* Note that the inner {@code Publisher} returned by the handler function should signal
19922018
* either {@code onNext}, {@code onError} or {@code onComplete} in response to the received
19932019
* {@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
20302056
/**
20312057
* Returns a Completable which first runs the other Completable
20322058
* 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="">
20332061
* <dl>
20342062
* <dt><b>Scheduler:</b></dt>
20352063
* <dd>{@code startWith} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2048,6 +2076,8 @@ public final Completable startWith(CompletableSource other) {
20482076
/**
20492077
* Returns an Observable which first delivers the events
20502078
* 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="">
20512081
* <dl>
20522082
* <dt><b>Scheduler:</b></dt>
20532083
* <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) {
20662096
/**
20672097
* Returns a Flowable which first delivers the events
20682098
* 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="">
20692101
* <dl>
20702102
* <dt><b>Backpressure:</b></dt>
20712103
* <dd>The returned {@code Flowable} honors the backpressure of the downstream consumer
@@ -2109,6 +2141,8 @@ public final Completable hide() {
21092141
/**
21102142
* Subscribes to this CompletableConsumable and returns a Disposable which can be used to cancel
21112143
* 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="">
21122146
* <dl>
21132147
* <dt><b>Scheduler:</b></dt>
21142148
* <dd>{@code subscribe} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2153,6 +2187,8 @@ public final void subscribe(CompletableObserver s) {
21532187
/**
21542188
* Subscribes a given CompletableObserver (subclass) to this Completable and returns the given
21552189
* 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="">
21562192
* <p>Usage example:
21572193
* <pre><code>
21582194
* Completable source = Completable.complete().delay(1, TimeUnit.SECONDS);
@@ -2183,6 +2219,8 @@ public final <E extends CompletableObserver> E subscribeWith(E observer) {
21832219

21842220
/**
21852221
* 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="">
21862224
* <dl>
21872225
* <dt><b>Scheduler:</b></dt>
21882226
* <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
22072245
* Subscribes to this Completable and calls the given Action when this Completable
22082246
* completes normally.
22092247
* <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>
22102250
* If the Completable emits an error, it is wrapped into an
22112251
* {@link io.reactivex.exceptions.OnErrorNotImplementedException OnErrorNotImplementedException}
22122252
* and routed to the RxJavaPlugins.onError handler.
@@ -2277,6 +2317,8 @@ public final Completable takeUntil(CompletableSource other) {
22772317
/**
22782318
* Returns a Completable that runs this Completable and emits a TimeoutException in case
22792319
* 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="">
22802322
* <dl>
22812323
* <dt><b>Scheduler:</b></dt>
22822324
* <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) {
22952337
/**
22962338
* Returns a Completable that runs this Completable and switches to the other Completable
22972339
* 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="">
22982342
* <dl>
22992343
* <dt><b>Scheduler:</b></dt>
23002344
* <dd>{@code timeout} subscribes to the other CompletableSource on
@@ -2317,6 +2361,8 @@ public final Completable timeout(long timeout, TimeUnit unit, CompletableSource
23172361
* Returns a Completable that runs this Completable and emits a TimeoutException in case
23182362
* this Completable doesn't complete within the given time while "waiting" on the specified
23192363
* 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="">
23202366
* <dl>
23212367
* <dt><b>Scheduler:</b></dt>
23222368
* <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
23372383
* Returns a Completable that runs this Completable and switches to the other Completable
23382384
* in case this Completable doesn't complete within the given time while "waiting" on
23392385
* 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="">
23402388
* <dl>
23412389
* <dt><b>Scheduler:</b></dt>
23422390
* <dd>{@code timeout} subscribes to the other CompletableSource on
@@ -2542,6 +2590,8 @@ public final Completable unsubscribeOn(final Scheduler scheduler) {
25422590
/**
25432591
* Creates a TestObserver and subscribes
25442592
* 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="">
25452595
* <dl>
25462596
* <dt><b>Scheduler:</b></dt>
25472597
* <dd>{@code test} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2561,6 +2611,8 @@ public final TestObserver<Void> test() {
25612611
* Creates a TestObserver optionally in cancelled state, then subscribes it to this Completable.
25622612
* @param cancelled if true, the TestObserver will be cancelled before subscribing to this
25632613
* 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="">
25642616
* <dl>
25652617
* <dt><b>Scheduler:</b></dt>
25662618
* <dd>{@code test} does not operate by default on a particular {@link Scheduler}.</dd>

0 commit comments

Comments
 (0)