Skip to content

Commit 5bfa84c

Browse files
DavidMGrossDavidMGross
committed
javadoc changes related to the mergeMap[Iterable] => flatMap[Iterable] changeover
1 parent b34bc69 commit 5bfa84c

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

‎rxjava-core/src/main/java/rx/Observable.java

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3848,7 +3848,7 @@ public final R call(R state, T value) {
38483848
* Observable
38493849
* @return an Observable that emits the result of applying the transformation function to each item emitted
38503850
* by the source Observable and concatinating the Observables obtained from this transformation
3851-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-and-concatmap">RxJava wiki: concatMap</a>
3851+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: concatMap</a>
38523852
*/
38533853
public final <R> Observable<R> concatMap(Func1<? super T, ? extends Observable<? extends R>> func) {
38543854
return concat(map(func));
@@ -4734,7 +4734,7 @@ public final Observable<T> firstOrDefault(T defaultValue, Func1<? super T, Boole
47344734
* @return an Observable that emits the result of applying the transformation function to each item emitted
47354735
* by the source Observable and merging the results of the Observables obtained from this
47364736
* transformation
4737-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-and-concatmap">RxJava wiki: flatMap</a>
4737+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
47384738
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.selectmany.aspx">MSDN: Observable.SelectMany</a>
47394739
*/
47404740
public final <R> Observable<R> flatMap(Func1<? super T, ? extends Observable<? extends R>> func) {
@@ -4748,7 +4748,7 @@ public final <R> Observable<R> flatMap(Func1<? super T, ? extends Observable<? e
47484748
* <img width="640" height="410" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/mergeMap.nce.png" alt="">
47494749
* <dl>
47504750
* <dt><b>Scheduler:</b></dt>
4751-
* <dd>{@code mergeMap} does not operate by default on a particular {@link Scheduler}.</dd>
4751+
* <dd>{@code flatMap} does not operate by default on a particular {@link Scheduler}.</dd>
47524752
* </dl>
47534753
*
47544754
* @param <R>
@@ -4763,7 +4763,8 @@ public final <R> Observable<R> flatMap(Func1<? super T, ? extends Observable<? e
47634763
* Observable
47644764
* @return an Observable that emits the results of merging the Observables returned from applying the
47654765
* specified functions to the emissions and notifications of the source Observable
4766-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMap</a>
4766+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
4767+
* @since 0.20
47674768
*/
47684769
public final <R> Observable<R> flatMap(
47694770
Func1<? super T, ? extends Observable<? extends R>> onNext,
@@ -4779,7 +4780,7 @@ public final <R> Observable<R> flatMap(
47794780
* <img width="640" height="390" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/mergeMap.r.png" alt="">
47804781
* <dl>
47814782
* <dt><b>Scheduler:</b></dt>
4782-
* <dd>{@code mergeMap} does not operate by default on a particular {@link Scheduler}.</dd>
4783+
* <dd>{@code flatMap} does not operate by default on a particular {@link Scheduler}.</dd>
47834784
* </dl>
47844785
*
47854786
* @param <U>
@@ -4793,7 +4794,8 @@ public final <R> Observable<R> flatMap(
47934794
* returns an item to be emitted by the resulting Observable
47944795
* @return an Observable that emits the results of applying a function to a pair of values emitted by the
47954796
* source Observable and the collection Observable
4796-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMap</a>
4797+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
4798+
* @since 0.20
47974799
*/
47984800
public final <U, R> Observable<R> flatMap(final Func1<? super T, ? extends Observable<? extends U>> collectionSelector,
47994801
final Func2<? super T, ? super U, ? extends R> resultSelector) {
@@ -4807,7 +4809,7 @@ public final <U, R> Observable<R> flatMap(final Func1<? super T, ? extends Obser
48074809
* <img width="640" height="310" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/mergeMapIterable.png" alt="">
48084810
* <dl>
48094811
* <dt><b>Scheduler:</b></dt>
4810-
* <dd>{@code mergeMapIterable} does not operate by default on a particular {@link Scheduler}.</dd>
4812+
* <dd>{@code flatMapIterable} does not operate by default on a particular {@link Scheduler}.</dd>
48114813
* </dl>
48124814
*
48134815
* @param <R>
@@ -4817,7 +4819,8 @@ public final <U, R> Observable<R> flatMap(final Func1<? super T, ? extends Obser
48174819
* source Observable
48184820
* @return an Observable that emits the results of merging the items emitted by the source Observable with
48194821
* the values in the Iterables corresponding to those items, as generated by {@code collectionSelector}
4820-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMapIterable</a>
4822+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMapIterable</a>
4823+
* @since 0.20
48214824
*/
48224825
public final <R> Observable<R> flatMapIterable(Func1<? super T, ? extends Iterable<? extends R>> collectionSelector) {
48234826
return merge(map(OperatorMapPair.convertSelector(collectionSelector)));
@@ -4830,7 +4833,7 @@ public final <R> Observable<R> flatMapIterable(Func1<? super T, ? extends Iterab
48304833
* <img width="640" height="390" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/mergeMapIterable.r.png" alt="">
48314834
* <dl>
48324835
* <dt><b>Scheduler:</b></dt>
4833-
* <dd>{@code mergeMapIterable} does not operate by default on a particular {@link Scheduler}.</dd>
4836+
* <dd>{@code flatMapIterable} does not operate by default on a particular {@link Scheduler}.</dd>
48344837
* </dl>
48354838
*
48364839
* @param <U>
@@ -4845,7 +4848,8 @@ public final <R> Observable<R> flatMapIterable(Func1<? super T, ? extends Iterab
48454848
* Iterable returned for that item by the {@code collectionSelector}
48464849
* @return an Observable that emits the items returned by {@code resultSelector} for each item in the source
48474850
* Observable
4848-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMapIterable</a>
4851+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMapIterable</a>
4852+
* @since 0.20
48494853
*/
48504854
public final <U, R> Observable<R> flatMapIterable(Func1<? super T, ? extends Iterable<? extends U>> collectionSelector,
48514855
Func2<? super T, ? super U, ? extends R> resultSelector) {
@@ -5334,9 +5338,9 @@ public final Observable<Notification<T>> materialize() {
53345338
* @return an Observable that emits the result of applying the transformation function to each item emitted
53355339
* by the source Observable and merging the results of the Observables obtained from these
53365340
* transformations
5337-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMap</a>
5341+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
53385342
* @see #flatMap(Func1)
5339-
* @deprecated use flatMap
5343+
* @deprecated use {@link #flatMap}
53405344
*/
53415345
@Deprecated
53425346
public final <R> Observable<R> mergeMap(Func1<? super T, ? extends Observable<? extends R>> func) {
@@ -5365,8 +5369,8 @@ public final <R> Observable<R> mergeMap(Func1<? super T, ? extends Observable<?
53655369
* Observable
53665370
* @return an Observable that emits the results of merging the Observables returned from applying the
53675371
* specified functions to the emissions and notifications of the source Observable
5368-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMap</a>
5369-
* @deprecated use flatMap
5372+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
5373+
* @deprecated use {@link #flatMap}
53705374
*/
53715375
@Deprecated
53725376
public final <R> Observable<R> mergeMap(
@@ -5397,8 +5401,8 @@ public final <R> Observable<R> mergeMap(
53975401
* returns an item to be emitted by the resulting Observable
53985402
* @return an Observable that emits the results of applying a function to a pair of values emitted by the
53995403
* source Observable and the collection Observable
5400-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMap</a>
5401-
* @deprecated use flatMap
5404+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMap</a>
5405+
* @deprecated use {@link #flatMap}
54025406
*/
54035407
@Deprecated
54045408
public final <U, R> Observable<R> mergeMap(Func1<? super T, ? extends Observable<? extends U>> collectionSelector,
@@ -5423,8 +5427,8 @@ public final <U, R> Observable<R> mergeMap(Func1<? super T, ? extends Observable
54235427
* source Observable
54245428
* @return an Observable that emits the results of merging the items emitted by the source Observable with
54255429
* the values in the Iterables corresponding to those items, as generated by {@code collectionSelector}
5426-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMapIterable</a>
5427-
* @deprecated use flatMapIterable
5430+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMapIterable</a>
5431+
* @deprecated use {@link #flatMapIterable}
54285432
*/
54295433
@Deprecated
54305434
public final <R> Observable<R> mergeMapIterable(Func1<? super T, ? extends Iterable<? extends R>> collectionSelector) {
@@ -5453,8 +5457,8 @@ public final <R> Observable<R> mergeMapIterable(Func1<? super T, ? extends Itera
54535457
* Iterable returned for that item by the {@code collectionSelector}
54545458
* @return an Observable that emits the items returned by {@code resultSelector} for each item in the source
54555459
* Observable
5456-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#mergemap-and-mergemapiterable">RxJava wiki: mergeMapIterable</a>
5457-
* @deprecated use flatMapIterable
5460+
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#flatmap-concatmap-and-flatmapiterable">RxJava wiki: flatMapIterable</a>
5461+
* @deprecated use {@link #flatMapIterable}
54585462
*/
54595463
@Deprecated
54605464
public final <U, R> Observable<R> mergeMapIterable(Func1<? super T, ? extends Iterable<? extends U>> collectionSelector,

0 commit comments

Comments
 (0)