Skip to content

Commit 3fd23c6

Browse files
committed
add diagram for new takeUntil variant
and a few other related javadoc tweaks and remove a troublesome unicode ligature from SpscArrayQueue.java that's causing a compiler warning
1 parent 48bff9d commit 3fd23c6

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

src/main/java/rx/Observable.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7849,6 +7849,7 @@ public final <E> Observable<T> takeUntil(Observable<? extends E> other) {
78497849
* @return an Observable that emits the items from the source Observable so long as each item satisfies the
78507850
* condition defined by {@code predicate}, then completes
78517851
* @see <a href="http://reactivex.io/documentation/operators/takewhile.html">ReactiveX operators documentation: TakeWhile</a>
7852+
* @see Observable#takeUntil(Func1)
78527853
*/
78537854
public final Observable<T> takeWhile(final Func1<? super T, Boolean> predicate) {
78547855
return lift(new OperatorTakeWhile<T>(predicate));
@@ -7858,13 +7859,17 @@ public final Observable<T> takeWhile(final Func1<? super T, Boolean> predicate)
78587859
* Returns an Observable that emits items emitted by the source Observable, checks the specified predicate
78597860
* for each item, and then completes if the condition is satisfied.
78607861
* <p>
7862+
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/takeUntil.p.png" alt="">
7863+
* <p>
78617864
* The difference between this operator and {@link #takeWhile(Func1)} is that here, the condition is
78627865
* evaluated <em>after</em> the item is emitted.
78637866
*
7867+
* @warn "Scheduler" and "Backpressure Support" sections missing from javadocs
78647868
* @param stopPredicate
78657869
* a function that evaluates an item emitted by the source Observable and returns a Boolean
78667870
* @return an Observable that first emits items emitted by the source Observable, checks the specified
78677871
* condition after each item, and then completes if the condition is satisfied.
7872+
* @see <a href="http://reactivex.io/documentation/operators/takeuntil.html">ReactiveX operators documentation: TakeUntil</a>
78687873
* @see Observable#takeWhile(Func1)
78697874
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
78707875
*/

src/main/java/rx/internal/util/unsafe/SpscArrayQueue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public SpscArrayQueueL3Pad(int capacity) {
9696
* Flow), and adjusted to comply with Queue.offer semantics with regards to capacity.<br>
9797
* For convenience the relevant papers are available in the resources folder:<br>
9898
* <i>2010 - Pisa - SPSC Queues on Shared Cache Multi-Core Systems.pdf<br>
99-
* 2012 - Junchang- BQueue- Efficient and Practical Queuing.pdf <br>
99+
* 2012 - Junchang- BQueue- Efficient and Practical Queuing.pdf <br>
100100
* </i> This implementation is wait free.
101101
*
102102
* @author nitsanw

0 commit comments

Comments
 (0)