Skip to content

Commit d1ac686

Browse files
committed
add marble diagrams to pivot() javadocs
1 parent 9df5173 commit d1ac686

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

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

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2490,24 +2490,29 @@ public final static <T> Observable<Observable<T>> parallelMerge(Observable<Obser
24902490

24912491
/**
24922492
* Pivot GroupedObservable streams without serializing/synchronizing to a single stream first.
2493+
* <p>
2494+
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/pivot.png">
24932495
*
2494-
* For example an Observable such as this =>
2495-
*
2496-
* Observable<GroupedObservable<String, GroupedObservable<Boolean, Integer>>>:
2497-
*
2498-
* o1.odd: 1, 3, 5, 7, 9 on Thread 1
2499-
* o1.even: 2, 4, 6, 8, 10 on Thread 1
2500-
* o2.odd: 11, 13, 15, 17, 19 on Thread 2
2501-
* o2.even: 12, 14, 16, 18, 20 on Thread 2
2496+
* For example an Observable such as this =&gt;
25022497
*
2503-
* is pivoted to become this =>
2504-
*
2505-
* Observable<GroupedObservable<Boolean, GroupedObservable<String, Integer>>>:
2498+
* {@code Observable<GroupedObservable<String, GroupedObservable<Boolean, Integer>>>}:
2499+
* <ul>
2500+
* <li>o1.odd: 1, 3, 5, 7, 9 on Thread 1</li>
2501+
* <li>o1.even: 2, 4, 6, 8, 10 on Thread 1</li>
2502+
* <li>o2.odd: 11, 13, 15, 17, 19 on Thread 2</li>
2503+
* <li>o2.even: 12, 14, 16, 18, 20 on Thread 2</li>
2504+
* </ul>
2505+
* is pivoted to become this =&gt;
25062506
*
2507-
* odd.o1: 1, 3, 5, 7, 9 on Thread 1
2508-
* odd.o2: 11, 13, 15, 17, 19 on Thread 2
2509-
* even.o1: 2, 4, 6, 8, 10 on Thread 1
2510-
* even.o2: 12, 14, 16, 18, 20 on Thread 2
2507+
* {@code Observable<GroupedObservable<Boolean, GroupedObservable<String, Integer>>>}:
2508+
* <ul>
2509+
* <li>odd.o1: 1, 3, 5, 7, 9 on Thread 1</li>
2510+
* <li>odd.o2: 11, 13, 15, 17, 19 on Thread 2</li>
2511+
* <li>even.o1: 2, 4, 6, 8, 10 on Thread 1</li>
2512+
* <li>even.o2: 12, 14, 16, 18, 20 on Thread 2</li>
2513+
* </ul>
2514+
* <p>
2515+
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/pivot.ex.png">
25112516
*
25122517
* @param groups
25132518
* @return

0 commit comments

Comments
 (0)