Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.x: Add missing Completable marbles (+17, 07/18a) #6090

Merged
merged 1 commit into from
Jul 18, 2018
Merged

2.x: Add missing Completable marbles (+17, 07/18a) #6090

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/main/java/io/reactivex/Completable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -903,6 +903,8 @@ private static NullPointerException toNpe(Throwable ex) {
* Returns a Completable instance which manages a resource along
* with a custom Completable instance while the subscription is active.
* <p>
* <img width="640" height="388" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.using.png" alt="">
* <p>
* This overload disposes eagerly before the terminal event is emitted.
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand All @@ -927,6 +929,8 @@ public static <R> Completable using(Callable<R> resourceSupplier,
* with a custom Completable instance while the subscription is active and performs eager or lazy
* resource disposition.
* <p>
* <img width="640" height="332" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.using.b.png" alt="">
* <p>
* If this overload performs a lazy cancellation after the terminal event is emitted.
* Exceptions thrown at this time will be delivered to RxJavaPlugins only.
* <dl>
Expand Down Expand Up @@ -959,6 +963,8 @@ public static <R> Completable using(
/**
* Wraps the given CompletableSource into a Completable
* if not already Completable.
* <p>
* <img width="640" height="354" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.wrap.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code wrap} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -980,6 +986,8 @@ public static Completable wrap(CompletableSource source) {
/**
* Returns a Completable that emits the a terminated event of either this Completable
* or the other Completable whichever fires first.
* <p>
* <img width="640" height="484" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.ambWith.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code ambWith} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1001,6 +1009,8 @@ public final Completable ambWith(CompletableSource other) {
* will subscribe to the {@code next} ObservableSource. An error event from this Completable will be
* propagated to the downstream subscriber and will result in skipping the subscription of the
* Observable.
* <p>
* <img width="640" height="278" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.andThen.o.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1022,6 +1032,8 @@ public final <T> Observable<T> andThen(ObservableSource<T> next) {
* will subscribe to the {@code next} Flowable. An error event from this Completable will be
* propagated to the downstream subscriber and will result in skipping the subscription of the
* Publisher.
* <p>
* <img width="640" height="249" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.andThen.p.png" alt="">
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The returned {@code Flowable} honors the backpressure of the downstream consumer
Expand All @@ -1047,6 +1059,8 @@ public final <T> Flowable<T> andThen(Publisher<T> next) {
* will subscribe to the {@code next} SingleSource. An error event from this Completable will be
* propagated to the downstream subscriber and will result in skipping the subscription of the
* Single.
* <p>
* <img width="640" height="437" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.andThen.s.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1068,6 +1082,8 @@ public final <T> Single<T> andThen(SingleSource<T> next) {
* will subscribe to the {@code next} MaybeSource. An error event from this Completable will be
* propagated to the downstream subscriber and will result in skipping the subscription of the
* Maybe.
* <p>
* <img width="640" height="280" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.andThen.m.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1088,6 +1104,8 @@ public final <T> Maybe<T> andThen(MaybeSource<T> next) {
* Returns a Completable that first runs this Completable
* and then the other completable.
* <p>
* <img width="640" height="437" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.andThen.c.png" alt="">
* <p>
* This is an alias for {@link #concatWith(CompletableSource)}.
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand All @@ -1106,6 +1124,8 @@ public final Completable andThen(CompletableSource next) {
/**
* Calls the specified converter function during assembly time and returns its resulting value.
* <p>
* <img width="640" height="751" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.as.png" alt="">
* <p>
* This allows fluent conversion to any other type.
* <dl>
* <dt><b>Scheduler:</b></dt>
Expand All @@ -1128,6 +1148,8 @@ public final <R> R as(@NonNull CompletableConverter<? extends R> converter) {
/**
* Subscribes to and awaits the termination of this Completable instance in a blocking manner and
* rethrows any exception emitted.
* <p>
* <img width="640" height="432" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.blockingAwait.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code blockingAwait} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1148,6 +1170,8 @@ public final void blockingAwait() {
/**
* Subscribes to and awaits the termination of this Completable instance in a blocking manner
* with a specific timeout and rethrows any exception emitted within the timeout window.
* <p>
* <img width="640" height="348" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.blockingAwait.t.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code blockingAwait} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1174,6 +1198,8 @@ public final boolean blockingAwait(long timeout, TimeUnit unit) {
/**
* Subscribes to this Completable instance and blocks until it terminates, then returns null or
* the emitted exception if any.
* <p>
* <img width="640" height="435" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.blockingGet.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code blockingGet} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1192,6 +1218,8 @@ public final Throwable blockingGet() {
/**
* Subscribes to this Completable instance and blocks until it terminates or the specified timeout
* elapses, then returns null for normal termination or the emitted exception if any.
* <p>
* <img width="640" height="348" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.blockingGet.t.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code blockingGet} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -1216,6 +1244,8 @@ public final Throwable blockingGet(long timeout, TimeUnit unit) {
* subscribes to the result Completable, caches its terminal event
* and relays/replays it to observers.
* <p>
* <img width="640" height="375" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.cache.png" alt="">
* <p>
* Note that this operator doesn't allow disposing the connection
* of the upstream source.
* <dl>
Expand All @@ -1235,6 +1265,8 @@ public final Completable cache() {
/**
* Calls the given transformer function with this instance and returns the function's resulting
* Completable.
* <p>
* <img width="640" height="625" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.compose.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code compose} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down Expand Up @@ -2308,6 +2340,8 @@ private Completable timeout0(long timeout, TimeUnit unit, Scheduler scheduler, C

/**
* Allows fluent conversion to another type via a function callback.
* <p>
* <img width="640" height="751" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.to.png" alt="">
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down