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: Improve Javadocs of flatMapSingle and flatMapMaybe #5709

Merged
merged 1 commit into from
Nov 9, 2017
Merged

2.x: Improve Javadocs of flatMapSingle and flatMapMaybe #5709

Show file tree
Hide file tree
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
18 changes: 10 additions & 8 deletions src/main/java/io/reactivex/Flowable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8945,8 +8945,8 @@ public final <U, V> Flowable<V> flatMapIterable(final Function<? super T, ? exte
}

/**
* Maps each element of the upstream Flowable into MaybeSources, subscribes to them and
* waits until the upstream and all MaybeSources complete.
* Maps each element of the upstream Flowable into MaybeSources, subscribes to all of them
* and merges their onSuccess values, in no particular order, into a single Flowable sequence.
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator consumes the upstream in an unbounded manner.</dd>
Expand All @@ -8965,8 +8965,9 @@ public final <R> Flowable<R> flatMapMaybe(Function<? super T, ? extends MaybeSou
}

/**
* Maps each element of the upstream Flowable into MaybeSources, subscribes to them and
* waits until the upstream and all MaybeSources complete, optionally delaying all errors.
* Maps each element of the upstream Flowable into MaybeSources, subscribes to at most
* {@code maxConcurrency} MaybeSources at a time and merges their onSuccess values,
* in no particular order, into a single Flowable sequence, optionally delaying all errors.
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>If {@code maxConcurrency == Integer.MAX_VALUE} the operator consumes the upstream in an unbounded manner.
Expand All @@ -8992,8 +8993,8 @@ public final <R> Flowable<R> flatMapMaybe(Function<? super T, ? extends MaybeSou
}

/**
* Maps each element of the upstream Flowable into SingleSources, subscribes to them and
* waits until the upstream and all SingleSources complete.
* Maps each element of the upstream Flowable into SingleSources, subscribes to all of them
* and merges their onSuccess values, in no particular order, into a single Flowable sequence.
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator consumes the upstream in an unbounded manner.</dd>
Expand All @@ -9012,8 +9013,9 @@ public final <R> Flowable<R> flatMapSingle(Function<? super T, ? extends SingleS
}

/**
* Maps each element of the upstream Flowable into SingleSources, subscribes to them and
* waits until the upstream and all SingleSources complete, optionally delaying all errors.
* Maps each element of the upstream Flowable into SingleSources, subscribes to at most
* {@code maxConcurrency} SingleSources at a time and merges their onSuccess values,
* in no particular order, into a single Flowable sequence, optionally delaying all errors.
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>If {@code maxConcurrency == Integer.MAX_VALUE} the operator consumes the upstream in an unbounded manner.
Expand Down
18 changes: 10 additions & 8 deletions src/main/java/io/reactivex/Observable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7944,8 +7944,8 @@ public final <U, V> Observable<V> flatMapIterable(final Function<? super T, ? ex
}

/**
* Maps each element of the upstream Observable into MaybeSources, subscribes to them and
* waits until the upstream and all MaybeSources complete.
* Maps each element of the upstream Observable into MaybeSources, subscribes to all of them
* and merges their onSuccess values, in no particular order, into a single Observable sequence.
* <p>
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMapMaybe.png" alt="">
* <dl>
Expand All @@ -7963,8 +7963,9 @@ public final <R> Observable<R> flatMapMaybe(Function<? super T, ? extends MaybeS
}

/**
* Maps each element of the upstream Observable into MaybeSources, subscribes to them and
* waits until the upstream and all MaybeSources complete, optionally delaying all errors.
* Maps each element of the upstream Observable into MaybeSources, subscribes to them
* and merges their onSuccess values, in no particular order, into a single Observable sequence,
* optionally delaying all errors.
* <p>
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMapMaybe.png" alt="">
* <dl>
Expand All @@ -7985,8 +7986,8 @@ public final <R> Observable<R> flatMapMaybe(Function<? super T, ? extends MaybeS
}

/**
* Maps each element of the upstream Observable into SingleSources, subscribes to them and
* waits until the upstream and all SingleSources complete.
* Maps each element of the upstream Observable into SingleSources, subscribes to all of them
* and merges their onSuccess values, in no particular order, into a single Observable sequence.
* <p>
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMapSingle.png" alt="">
* <dl>
Expand All @@ -8004,8 +8005,9 @@ public final <R> Observable<R> flatMapSingle(Function<? super T, ? extends Singl
}

/**
* Maps each element of the upstream Observable into SingleSources, subscribes to them and
* waits until the upstream and all SingleSources complete, optionally delaying all errors.
* Maps each element of the upstream Observable into SingleSources, subscribes to them
* and merges their onSuccess values, in no particular order, into a single Observable sequence,
* optionally delaying all errors.
* <p>
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMapSingle.png" alt="">
* <dl>
Expand Down