Skip to content

Commit 523583e

Browse files
committed
Removing deprecated operators from operator decision trees
1 parent ad89403 commit 523583e

File tree

2 files changed

+30
-18
lines changed

2 files changed

+30
-18
lines changed

operators.html

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<dt>I want to create a new Observable</dt>
5050
<dd class="sub"><dl>
5151
<dt>that emits a particular item</dt>
52-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#just"><code>just(&#8239;)</code></a></dd>
52+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#just"><code>just(&#8239;)</code></a></dd>
5353
<dd class="sub"><dl>
5454
<dt>that was returned from a function called at subscribe-time</dt>
5555
<dd class="a"><a href="https://github.com/ReactiveX/RxJava/wiki/Async-Operators#start"><code>start(&#8239;)</code></a></dd>
@@ -105,7 +105,7 @@
105105
</dl></dd>
106106
</dl></dd>
107107
<dt>that completes without emitting items</dt>
108-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#empty"><code>empty(&#8239;)</code></a></dd>
108+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#empty"><code>empty(&#8239;)</code></a></dd>
109109
<dt>that does nothing at all</dt>
110110
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#never"><code>never(&#8239;)</code></a></dd>
111111
</dl></dd>
@@ -117,12 +117,12 @@
117117
<dt>where the source Observables are passed to the operator as parameters</dt>
118118
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(&hellip;)</code></a></dd>
119119
<dt>where the source Observables are found in an Array</dt>
120-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
120+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
121121
<dt>where the source Observables are found in an Iterable or Observable</dt>
122-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
122+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
123123
<dd class="sub"><dl>
124124
<dt>but I only want to process a certain number of them at once</dt>
125-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences,maxConcurrent)</code></a></dd>
125+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences,maxConcurrent)</code></a></dd>
126126
</dl></dd>
127127
<dt>but not forwarding any error notifications until all source Observables have terminated</dt>
128128
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#mergedelayerror"><code>mergeDelayError(&#8239;)</code></a></dd>
@@ -148,8 +148,10 @@
148148
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#switchonnext"><code>switchOnNext(&#8239;)</code></a></dd>
149149
<dt>and mirroring only one of those Observables (which one depends on a parameter I am passed)</dt>
150150
<dd class="c"><a href="https://github.com/ReactiveX/RxJava/wiki/Conditional-and-Boolean-Operators#switchCase"><code>switchCase(&#8239;)</code></a></dd>
151+
<!-- deprecated
151152
<dt>reducing an Observable that emits many Observables to one that emits as many Observables as I have processes to process them on</dt>
152153
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#parallelmerge"><code>parallelMerge(&hellip;)</code></a></dd>
154+
-->
153155
</dl></dd>
154156

155157
<dt>I want emit the items from an Observable after transforming them</dt>
@@ -177,7 +179,7 @@
177179
<dt>by attaching a timestamp to them</dt>
178180
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#timestamp"><code>timestamp(&#8239;)</code></a></dd>
179181
<dt>into an indicator of the amount of time that lapsed before the emission of the item</dt>
180-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#itmeinterval"><code>timeInterval(&#8239;)</code></a></dd>
182+
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#timeinterval"><code>timeInterval(&#8239;)</code></a></dd>
181183
</dl></dd>
182184

183185
<dt>I want to shift the items emitted by an Observable forward in time before reemitting them</dt>
@@ -209,7 +211,7 @@
209211
<dt>I want to mirror an Observable but prefix items to its sequence</dt>
210212
<dd class="sub"><dl>
211213
<dt>obtained from an Array or Iterable</dt>
212-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
214+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
213215
<dt>obtained from an Observable</dt>
214216
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
215217
<dt>passed as parameters to the operator</dt>
@@ -293,8 +295,10 @@
293295
<dd class="sub"><dl>
294296
<dt>and transforming the items before emitting them on those Observables</dt>
295297
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil"><code>groupByUntil(keySelector,valueSelector,durationSelector)</code></a></dd>
298+
<!-- deprecated
296299
<dt>and then collecting similarly grouped Observables back together again</dt>
297300
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#pivot"><code>pivot(&#8239;)</code></a></dd>
301+
-->
298302
</dl></dd>
299303
</dl></dd>
300304
</dl></dd>
@@ -440,7 +444,7 @@
440444
<dt>based on a timer</dt>
441445
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>throttleWithTimeout(time,unit)</code></a></dd>
442446
<dt>based on emissions from another Observable</dt>
443-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>debounce(debounceSelector)</code></a></dd>
447+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>debounce(debounceSelector)</code></a></dd>
444448
</dl></dd>
445449
<dt>by suppressing items that are duplicates of already-emitted items</dt>
446450
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#distinct"><code>distinct(&#8239;)</code></a></dd>
@@ -579,7 +583,7 @@
579583
</dl></dd>
580584

581585
<dt>I want an Observable that will notify observers of an error</dt>
582-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#error"><code>error(&#8239;)</code></a></dd>
586+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#error"><code>error(&#8239;)</code></a></dd>
583587
<dd class="sub"><dl>
584588
<dt>if a specified period of time elapses without it emitting an item</dt>
585589
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#timeout"><code>timeout(time,unit)</code></a></dd>
@@ -599,10 +603,12 @@
599603
</dl></dd>
600604
<dt>by switching to a backup Observable returned from a function that is passed the error</dt>
601605
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorresumenext"><code>onErrorResumeNext(throwable,function)</code></a></dd>
606+
<!-- deprecated
602607
<dd class="sub"><dl>
603608
<dt>and by then continuing to observe the source Observable in spite of the error termination</dt>
604609
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorflatmap"><code>onErrorFlatMap(&#8239;)</code></a></dd>
605610
</dl></dd>
611+
-->
606612
<dt>by emitting a particular item and completing normally</dt>
607613
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorreturn"><code>onErrorReturn(&#8239;)</code></a></dd>
608614
<dt>by attempting to resubscribe to the upstream Observable</dt>

operators.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<dt>I want to create a new Observable</dt>
4040
<dd class="sub"><dl>
4141
<dt>that emits a particular item</dt>
42-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#just"><code>just(&#8239;)</code></a></dd>
42+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#just"><code>just(&#8239;)</code></a></dd>
4343
<dd class="sub"><dl>
4444
<dt>that was returned from a function called at subscribe-time</dt>
4545
<dd class="a"><a href="https://github.com/ReactiveX/RxJava/wiki/Async-Operators#start"><code>start(&#8239;)</code></a></dd>
@@ -95,7 +95,7 @@
9595
</dl></dd>
9696
</dl></dd>
9797
<dt>that completes without emitting items</dt>
98-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#empty"><code>empty(&#8239;)</code></a></dd>
98+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#empty"><code>empty(&#8239;)</code></a></dd>
9999
<dt>that does nothing at all</dt>
100100
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#never"><code>never(&#8239;)</code></a></dd>
101101
</dl></dd>
@@ -107,12 +107,12 @@
107107
<dt>where the source Observables are passed to the operator as parameters</dt>
108108
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(&hellip;)</code></a></dd>
109109
<dt>where the source Observables are found in an Array</dt>
110-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
110+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
111111
<dt>where the source Observables are found in an Iterable or Observable</dt>
112-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
112+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences)</code></a></dd>
113113
<dd class="sub"><dl>
114114
<dt>but I only want to process a certain number of them at once</dt>
115-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences,maxConcurrent)</code></a></dd>
115+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#merge"><code>merge(sequences,maxConcurrent)</code></a></dd>
116116
</dl></dd>
117117
<dt>but not forwarding any error notifications until all source Observables have terminated</dt>
118118
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#mergedelayerror"><code>mergeDelayError(&#8239;)</code></a></dd>
@@ -138,8 +138,10 @@
138138
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#switchonnext"><code>switchOnNext(&#8239;)</code></a></dd>
139139
<dt>and mirroring only one of those Observables (which one depends on a parameter I am passed)</dt>
140140
<dd class="c"><a href="https://github.com/ReactiveX/RxJava/wiki/Conditional-and-Boolean-Operators#switchCase"><code>switchCase(&#8239;)</code></a></dd>
141+
<!-- deprecated
141142
<dt>reducing an Observable that emits many Observables to one that emits as many Observables as I have processes to process them on</dt>
142143
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#parallelmerge"><code>parallelMerge(&hellip;)</code></a></dd>
144+
-->
143145
</dl></dd>
144146

145147
<dt>I want emit the items from an Observable after transforming them</dt>
@@ -167,7 +169,7 @@
167169
<dt>by attaching a timestamp to them</dt>
168170
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#timestamp"><code>timestamp(&#8239;)</code></a></dd>
169171
<dt>into an indicator of the amount of time that lapsed before the emission of the item</dt>
170-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#itmeinterval"><code>timeInterval(&#8239;)</code></a></dd>
172+
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#timeinterval"><code>timeInterval(&#8239;)</code></a></dd>
171173
</dl></dd>
172174

173175
<dt>I want to shift the items emitted by an Observable forward in time before reemitting them</dt>
@@ -199,7 +201,7 @@
199201
<dt>I want to mirror an Observable but prefix items to its sequence</dt>
200202
<dd class="sub"><dl>
201203
<dt>obtained from an Array or Iterable</dt>
202-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
204+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
203205
<dt>obtained from an Observable</dt>
204206
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Combining-Observables#startwith"><code>startWith(values)</code></a></dd>
205207
<dt>passed as parameters to the operator</dt>
@@ -283,8 +285,10 @@
283285
<dd class="sub"><dl>
284286
<dt>and transforming the items before emitting them on those Observables</dt>
285287
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil"><code>groupByUntil(keySelector,valueSelector,durationSelector)</code></a></dd>
288+
<!-- deprecated
286289
<dt>and then collecting similarly grouped Observables back together again</dt>
287290
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#pivot"><code>pivot(&#8239;)</code></a></dd>
291+
-->
288292
</dl></dd>
289293
</dl></dd>
290294
</dl></dd>
@@ -430,7 +434,7 @@
430434
<dt>based on a timer</dt>
431435
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>throttleWithTimeout(time,unit)</code></a></dd>
432436
<dt>based on emissions from another Observable</dt>
433-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>debounce(debounceSelector)</code></a></dd>
437+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#throttlewithtimeout-or-debounce"><code>debounce(debounceSelector)</code></a></dd>
434438
</dl></dd>
435439
<dt>by suppressing items that are duplicates of already-emitted items</dt>
436440
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#distinct"><code>distinct(&#8239;)</code></a></dd>
@@ -569,7 +573,7 @@
569573
</dl></dd>
570574

571575
<dt>I want an Observable that will notify observers of an error</dt>
572-
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#error"><code>error(&#8239;)</code></a></dd>
576+
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Creating-Observables#error"><code>error(&#8239;)</code></a></dd>
573577
<dd class="sub"><dl>
574578
<dt>if a specified period of time elapses without it emitting an item</dt>
575579
<dd class="s"><a href="https://github.com/ReactiveX/RxJava/wiki/Filtering-Observables#timeout"><code>timeout(time,unit)</code></a></dd>
@@ -589,10 +593,12 @@
589593
</dl></dd>
590594
<dt>by switching to a backup Observable returned from a function that is passed the error</dt>
591595
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorresumenext"><code>onErrorResumeNext(throwable,function)</code></a></dd>
596+
<!-- deprecated
592597
<dd class="sub"><dl>
593598
<dt>and by then continuing to observe the source Observable in spite of the error termination</dt>
594599
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorflatmap"><code>onErrorFlatMap(&#8239;)</code></a></dd>
595600
</dl></dd>
601+
-->
596602
<dt>by emitting a particular item and completing normally</dt>
597603
<dd><a href="https://github.com/ReactiveX/RxJava/wiki/Error-Handling-Operators#onerrorreturn"><code>onErrorReturn(&#8239;)</code></a></dd>
598604
<dt>by attempting to resubscribe to the upstream Observable</dt>

0 commit comments

Comments
 (0)