Skip to content

Commit 3f9ffae

Browse files
authored
2.x: Improve Javadocs of flatMapSingle and flatMapMaybe (#5709)
1 parent 1099084 commit 3f9ffae

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

src/main/java/io/reactivex/Flowable.java

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8945,8 +8945,8 @@ public final <U, V> Flowable<V> flatMapIterable(final Function<? super T, ? exte
89458945
}
89468946

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

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

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

90149015
/**
9015-
* Maps each element of the upstream Flowable into SingleSources, subscribes to them and
9016-
* waits until the upstream and all SingleSources complete, optionally delaying all errors.
9016+
* Maps each element of the upstream Flowable into SingleSources, subscribes to at most
9017+
* {@code maxConcurrency} SingleSources at a time and merges their onSuccess values,
9018+
* in no particular order, into a single Flowable sequence, optionally delaying all errors.
90179019
* <dl>
90189020
* <dt><b>Backpressure:</b></dt>
90199021
* <dd>If {@code maxConcurrency == Integer.MAX_VALUE} the operator consumes the upstream in an unbounded manner.

src/main/java/io/reactivex/Observable.java

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7944,8 +7944,8 @@ public final <U, V> Observable<V> flatMapIterable(final Function<? super T, ? ex
79447944
}
79457945

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

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

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

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

0 commit comments

Comments
 (0)