Skip to content

Commit a55f125

Browse files
author
Your Name
committed
Changed java docs to not suggesting if operation is hot
1 parent d4a98e2 commit a55f125

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

src/main/java/rx/Observable.java

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3285,9 +3285,9 @@ public final <TClosing> Observable<List<T>> buffer(Func0<? extends Observable<?
32853285
/**
32863286
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
32873287
* Observable emits connected, non-overlapping buffers, each containing {@code count} items. When the source
3288-
* Observable completes, the current buffer is emitted, and the event is propagated to all subscribed
3289-
* {@link Observer}s. Note that if the source {@link Observable} issues an onError notification the event
3290-
* is passed on immediately without first emitting the buffer it is in the process of assembling.
3288+
* Observable completes, the resulting Observable emits the current buffer and propagates the notification
3289+
* from the source Observable. Note that if the source Observable issues an onError notification
3290+
* the event is passed on immediately without first emitting the buffer it is in the process of assembling.
32913291
* <p>
32923292
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer3.png" alt="">
32933293
* <dl>
@@ -3308,9 +3308,9 @@ public final Observable<List<T>> buffer(int count) {
33083308
/**
33093309
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
33103310
* Observable emits buffers every {@code skip} items, each containing {@code count} items. When the source
3311-
* Observable completes, the current buffer is emitted, and the event is propagated to all subscribed
3312-
* {@link Observer}s. Note that if the source {@link Observable} issues an onError notification the event
3313-
* is passed on immediately without first emitting the buffer it is in the process of assembling.
3311+
* Observable completes, the resulting Observable emits the current buffer and propagates the notification
3312+
* from the source Observable. Note that if the source Observable issues an onError notification
3313+
* the event is passed on immediately without first emitting the buffer it is in the process of assembling.
33143314
* <p>
33153315
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer4.png" alt="">
33163316
* <dl>
@@ -3336,9 +3336,9 @@ public final Observable<List<T>> buffer(int count, int skip) {
33363336
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
33373337
* Observable starts a new buffer periodically, as determined by the {@code timeshift} argument. It emits
33383338
* each buffer after a fixed timespan, specified by the {@code timespan} argument. When the source
3339-
* Observable completes, the current buffer is emitted, and the event is propagated to all subscribed
3340-
* {@link Observer}s. Note that if the source {@link Observable} issues an onError notification the event
3341-
* is passed on immediately without first emitting the buffer it is in the process of assembling.
3339+
* Observable completes, the resulting Observable emits the current buffer and propagates the notification
3340+
* from the source Observable. Note that if the source Observable issues an onError notification
3341+
* the event is passed on immediately without first emitting the buffer it is in the process of assembling.
33423342
* <p>
33433343
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer7.png" alt="">
33443344
* <dl>
@@ -3367,10 +3367,10 @@ public final Observable<List<T>> buffer(long timespan, long timeshift, TimeUnit
33673367
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
33683368
* Observable starts a new buffer periodically, as determined by the {@code timeshift} argument, and on the
33693369
* specified {@code scheduler}. It emits each buffer after a fixed timespan, specified by the
3370-
* {@code timespan} argument. When the source Observable completes completes, the current buffer is emitted,
3371-
* and the event is propagated to all subscribed {@link Observer}s. Note that if the source {@link Observable}
3372-
* issues an onError notification the event is passed on immediately without first emitting the buffer it is
3373-
* in the process of assembling.
3370+
* {@code timespan} argument. When the source Observable completes, the resulting Observable emits the current
3371+
* buffer and propagates the notification from the source Observable. Note that if the source
3372+
* Observable issues an onError notification the event is passed on immediately without first emitting
3373+
* the buffer it is in the process of assembling.
33743374
* <p>
33753375
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer7.s.png" alt="">
33763376
* <dl>
@@ -3400,10 +3400,10 @@ public final Observable<List<T>> buffer(long timespan, long timeshift, TimeUnit
34003400
/**
34013401
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
34023402
* Observable emits connected, non-overlapping buffers, each of a fixed duration specified by the
3403-
* {@code timespan} argument. When the source Observable completes, the current buffer is emitted,
3404-
* and the event is propagated to all subscribed {@link Observer}s. Note that if the source {@link Observable}
3405-
* issues an onError notification the event is passed on immediately without first emitting the buffer it is
3406-
* in the process of assembling.
3403+
* {@code timespan} argument. When the source Observable completes, the resulting Observable emits the current
3404+
* buffer and propagates the notification from the source Observable. Note that if the source
3405+
* Observable issues an onError notification the event is passed on immediately without first emitting
3406+
* the buffer it is in the process of assembling.
34073407
* <p>
34083408
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer5.png" alt="">
34093409
* <dl>
@@ -3431,9 +3431,9 @@ public final Observable<List<T>> buffer(long timespan, TimeUnit unit) {
34313431
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
34323432
* Observable emits connected, non-overlapping buffers, each of a fixed duration specified by the
34333433
* {@code timespan} argument or a maximum size specified by the {@code count} argument (whichever is reached
3434-
* first). When the source Observable completes, the current buffer is emitted, and the event is propagated
3435-
* to all subscribed {@link Observer}s. Note that if the source {@link Observable} issues an onError
3436-
* notification the event is passed on immediately without first emitting the buffer it is in the process
3434+
* first). When the source Observable completes, the resulting Observable emits the current buffer and propagates
3435+
* the notification from the source Observable. Note that if the source Observable issues an onError
3436+
* notification the event is passed on immediately without first emitting the buffer it is in the process
34373437
* of assembling.
34383438
* <p>
34393439
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer6.png" alt="">
@@ -3465,9 +3465,9 @@ public final Observable<List<T>> buffer(long timespan, TimeUnit unit, int count)
34653465
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
34663466
* Observable emits connected, non-overlapping buffers, each of a fixed duration specified by the
34673467
* {@code timespan} argument as measured on the specified {@code scheduler}, or a maximum size specified by
3468-
* the {@code count} argument (whichever is reached first). When the source Observable completes, the
3469-
* current buffer is emitted, and the event is propagated to all subscribed {@link Observer}s. Note that
3470-
* if the source {@link Observable} issues an onError notification the event is passed on immediately
3468+
* the {@code count} argument (whichever is reached first). When the source Observable completes, the resulting
3469+
* Observable emits the current buffer and propagates the notification from the source Observable.
3470+
* Note that if the source Observable issues an onError notification the event is passed on immediately
34713471
* without first emitting the buffer it is in the process of assembling.
34723472
* <p>
34733473
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer6.s.png" alt="">
@@ -3501,8 +3501,8 @@ public final Observable<List<T>> buffer(long timespan, TimeUnit unit, int count,
35013501
* Returns an Observable that emits buffers of items it collects from the source Observable. The resulting
35023502
* Observable emits connected, non-overlapping buffers, each of a fixed duration specified by the
35033503
* {@code timespan} argument and on the specified {@code scheduler}. When the source Observable completes,
3504-
* the current buffer is emitted, and the event is propagated to all subscribed {@link Observer}s. Note
3505-
* that if the source {@link Observable} issues an onError notification the event is passed on immediately
3504+
* the resulting Observable emits the current buffer and propagates the notification from the source Observable.
3505+
* Note that if the source Observable issues an onError notification the event is passed on immediately
35063506
* without first emitting the buffer it is in the process of assembling.
35073507
* <p>
35083508
* <img width="640" height="320" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/buffer5.s.png" alt="">

src/main/java/rx/internal/operators/OperatorBufferWithSize.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* values from the specified {@link Observable} source and stores them in all active chunks until the buffer
3232
* contains a specified number of elements. The buffer is then emitted. Chunks are created after a certain
3333
* amount of values have been received. When the source {@link Observable} completes, the current buffer is
34-
* emitted, and the event is propagated to all subscribed {@link Observer}s. Note that if the source
34+
* emitted, and the event is propagated to all subscribed {@link Subscriber}s. Note that if the source
3535
* {@link Observable} issues an onError notification the event is passed on immediately without first emitting
3636
* the buffer it is in the process of assembling.
3737
* <p>

src/main/java/rx/internal/operators/OperatorBufferWithTime.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* is emitted and replaced with a new buffer. How often this is done depends on the specified timespan.
3636
* The creation of chunks is also periodical. How often this is done depends on the specified timeshift.
3737
* When the source {@link Observable} completes, the current buffer is emitted, and the event is propagated
38-
* to all subscribed {@link Observer}s. Note that if the source {@link Observable} issues an onError
38+
* to all subscribed {@link Subscriber}s. Note that if the source {@link Observable} issues an onError
3939
* notification the event is passed on immediately without first emitting the buffer it is in the process
4040
* of assembling.
4141
* <p>

0 commit comments

Comments
 (0)