Skip to content

Commit 382ba69

Browse files
authored
2.x: Add missing Completable marbles (+19, 07/19a) (#6097)
1 parent 27c63b6 commit 382ba69

File tree

1 file changed

+44
-4
lines changed

1 file changed

+44
-4
lines changed

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

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1283,6 +1283,8 @@ public final Completable compose(CompletableTransformer transformer) {
12831283

12841284
/**
12851285
* Concatenates this Completable with another Completable.
1286+
* <p>
1287+
* <img width="640" height="317" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.concatWith.png" alt="">
12861288
* <dl>
12871289
* <dt><b>Scheduler:</b></dt>
12881290
* <dd>{@code concatWith} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1304,6 +1306,8 @@ public final Completable concatWith(CompletableSource other) {
13041306

13051307
/**
13061308
* Returns a Completable which delays the emission of the completion event by the given time.
1309+
* <p>
1310+
* <img width="640" height="343" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.delay.png" alt="">
13071311
* <dl>
13081312
* <dt><b>Scheduler:</b></dt>
13091313
* <dd>{@code delay} does operate by default on the {@code computation} {@link Scheduler}.</dd>
@@ -1322,6 +1326,8 @@ public final Completable delay(long delay, TimeUnit unit) {
13221326
/**
13231327
* Returns a Completable which delays the emission of the completion event by the given time while
13241328
* running on the specified scheduler.
1329+
* <p>
1330+
* <img width="640" height="313" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.delay.s.png" alt="">
13251331
* <dl>
13261332
* <dt><b>Scheduler:</b></dt>
13271333
* <dd>{@code delay} operates on the {@link Scheduler} you specify.</dd>
@@ -1341,6 +1347,8 @@ public final Completable delay(long delay, TimeUnit unit, Scheduler scheduler) {
13411347
/**
13421348
* Returns a Completable which delays the emission of the completion event, and optionally the error as well, by the given time while
13431349
* running on the specified scheduler.
1350+
* <p>
1351+
* <img width="640" height="253" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.delay.sb.png" alt="">
13441352
* <dl>
13451353
* <dt><b>Scheduler:</b></dt>
13461354
* <dd>{@code delay} operates on the {@link Scheduler} you specify.</dd>
@@ -1362,6 +1370,8 @@ public final Completable delay(final long delay, final TimeUnit unit, final Sche
13621370

13631371
/**
13641372
* Returns a Completable which calls the given onComplete callback if this Completable completes.
1373+
* <p>
1374+
* <img width="640" height="304" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnComplete.png" alt="">
13651375
* <dl>
13661376
* <dt><b>Scheduler:</b></dt>
13671377
* <dd>{@code doOnComplete} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1382,6 +1392,8 @@ public final Completable doOnComplete(Action onComplete) {
13821392
/**
13831393
* Calls the shared {@code Action} if a CompletableObserver subscribed to the current
13841394
* Completable disposes the common Disposable it received via onSubscribe.
1395+
* <p>
1396+
* <img width="640" height="589" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnDispose.png" alt="">
13851397
* <dl>
13861398
* <dt><b>Scheduler:</b></dt>
13871399
* <dd>{@code doOnDispose} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1400,6 +1412,8 @@ public final Completable doOnDispose(Action onDispose) {
14001412

14011413
/**
14021414
* Returns a Completable which calls the given onError callback if this Completable emits an error.
1415+
* <p>
1416+
* <img width="640" height="304" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnError.png" alt="">
14031417
* <dl>
14041418
* <dt><b>Scheduler:</b></dt>
14051419
* <dd>{@code doOnError} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1420,6 +1434,8 @@ public final Completable doOnError(Consumer<? super Throwable> onError) {
14201434
/**
14211435
* Returns a Completable which calls the given onEvent callback with the (throwable) for an onError
14221436
* or (null) for an onComplete signal from this Completable before delivering said signal to the downstream.
1437+
* <p>
1438+
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnEvent.png" alt="">
14231439
* <dl>
14241440
* <dt><b>Scheduler:</b></dt>
14251441
* <dd>{@code doOnEvent} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1470,6 +1486,8 @@ private Completable doOnLifecycle(
14701486
/**
14711487
* Returns a Completable instance that calls the given onSubscribe callback with the disposable
14721488
* that child subscribers receive on subscription.
1489+
* <p>
1490+
* <img width="640" height="304" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnSubscribe.png" alt="">
14731491
* <dl>
14741492
* <dt><b>Scheduler:</b></dt>
14751493
* <dd>{@code doOnSubscribe} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1489,6 +1507,8 @@ public final Completable doOnSubscribe(Consumer<? super Disposable> onSubscribe)
14891507
/**
14901508
* Returns a Completable instance that calls the given onTerminate callback just before this Completable
14911509
* completes normally or with an exception.
1510+
* <p>
1511+
* <img width="640" height="304" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doOnTerminate.png" alt="">
14921512
* <dl>
14931513
* <dt><b>Scheduler:</b></dt>
14941514
* <dd>{@code doOnTerminate} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1508,6 +1528,8 @@ public final Completable doOnTerminate(final Action onTerminate) {
15081528
/**
15091529
* Returns a Completable instance that calls the given onTerminate callback after this Completable
15101530
* completes normally or with an exception.
1531+
* <p>
1532+
* <img width="640" height="304" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doAfterTerminate.png" alt="">
15111533
* <dl>
15121534
* <dt><b>Scheduler:</b></dt>
15131535
* <dd>{@code doAfterTerminate} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1530,9 +1552,13 @@ public final Completable doAfterTerminate(final Action onAfterTerminate) {
15301552
/**
15311553
* Calls the specified action after this Completable signals onError or onComplete or gets disposed by
15321554
* the downstream.
1533-
* <p>In case of a race between a terminal event and a dispose call, the provided {@code onFinally} action
1555+
* <p>
1556+
* <img width="640" height="331" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.doFinally.png" alt="">
1557+
* <p>
1558+
* In case of a race between a terminal event and a dispose call, the provided {@code onFinally} action
15341559
* is executed once per subscription.
1535-
* <p>Note that the {@code onFinally} action is shared between subscriptions and as such
1560+
* <p>
1561+
* Note that the {@code onFinally} action is shared between subscriptions and as such
15361562
* should be thread-safe.
15371563
* <dl>
15381564
* <dt><b>Scheduler:</b></dt>
@@ -1688,6 +1714,8 @@ public final Completable lift(final CompletableOperator onLift) {
16881714
/**
16891715
* Returns a Completable which subscribes to this and the other Completable and completes
16901716
* when both of them complete or one emits an error.
1717+
* <p>
1718+
* <img width="640" height="442" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.mergeWith.png" alt="">
16911719
* <dl>
16921720
* <dt><b>Scheduler:</b></dt>
16931721
* <dd>{@code mergeWith} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1705,6 +1733,8 @@ public final Completable mergeWith(CompletableSource other) {
17051733

17061734
/**
17071735
* Returns a Completable which emits the terminal events from the thread of the specified scheduler.
1736+
* <p>
1737+
* <img width="640" height="523" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.observeOn.png" alt="">
17081738
* <dl>
17091739
* <dt><b>Scheduler:</b></dt>
17101740
* <dd>{@code observeOn} operates on a {@link Scheduler} you specify.</dd>
@@ -1723,6 +1753,8 @@ public final Completable observeOn(final Scheduler scheduler) {
17231753
/**
17241754
* Returns a Completable instance that if this Completable emits an error, it will emit an onComplete
17251755
* and swallow the throwable.
1756+
* <p>
1757+
* <img width="640" height="585" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.onErrorComplete.png" alt="">
17261758
* <dl>
17271759
* <dt><b>Scheduler:</b></dt>
17281760
* <dd>{@code onErrorComplete} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1738,6 +1770,8 @@ public final Completable onErrorComplete() {
17381770
/**
17391771
* Returns a Completable instance that if this Completable emits an error and the predicate returns
17401772
* true, it will emit an onComplete and swallow the throwable.
1773+
* <p>
1774+
* <img width="640" height="283" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.onErrorComplete.f.png" alt="">
17411775
* <dl>
17421776
* <dt><b>Scheduler:</b></dt>
17431777
* <dd>{@code onErrorComplete} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1758,6 +1792,8 @@ public final Completable onErrorComplete(final Predicate<? super Throwable> pred
17581792
* Returns a Completable instance that when encounters an error from this Completable, calls the
17591793
* specified mapper function that returns another Completable instance for it and resumes the
17601794
* execution with it.
1795+
* <p>
1796+
* <img width="640" height="426" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.onErrorResumeNext.png" alt="">
17611797
* <dl>
17621798
* <dt><b>Scheduler:</b></dt>
17631799
* <dd>{@code onErrorResumeNext} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1776,6 +1812,8 @@ public final Completable onErrorResumeNext(final Function<? super Throwable, ? e
17761812
/**
17771813
* Nulls out references to the upstream producer and downstream CompletableObserver if
17781814
* the sequence is terminated or downstream calls dispose().
1815+
* <p>
1816+
* <img width="640" height="326" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.onTerminateDetach.png" alt="">
17791817
* <dl>
17801818
* <dt><b>Scheduler:</b></dt>
17811819
* <dd>{@code onTerminateDetach} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2050,8 +2088,10 @@ public final <T> Flowable<T> startWith(Publisher<T> other) {
20502088

20512089
/**
20522090
* Hides the identity of this Completable and its Disposable.
2053-
* <p>Allows preventing certain identity-based
2054-
* optimizations (fusion).
2091+
* <p>
2092+
* <img width="640" height="432" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.hide.png" alt="">
2093+
* <p>
2094+
* Allows preventing certain identity-based optimizations (fusion).
20552095
* <dl>
20562096
* <dt><b>Scheduler:</b></dt>
20572097
* <dd>{@code hide} does not operate by default on a particular {@link Scheduler}.</dd>

0 commit comments

Comments
 (0)