Skip to content

Commit b21aef9

Browse files
committed
minor tweaks to javadocs for new onBackpressureBuffer variants
1 parent ea3732d commit b21aef9

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

src/main/java/rx/Observable.java

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5037,40 +5037,42 @@ public final Observable<T> onBackpressureBuffer() {
50375037
}
50385038

50395039
/**
5040-
* Instructs an Observable that is emitting items faster than its observer can consume them to buffer
5041-
* up to a given amount of items until they can be emitted. The resulting Observable will {@code onError} emitting a
5042-
* {@link java.nio.BufferOverflowException} as soon as the buffer's capacity is exceeded, dropping all
5043-
* undelivered items, and unsubscribing from the source.
5040+
* Instructs an Observable that is emitting items faster than its observer can consume them to buffer up to
5041+
* a given amount of items until they can be emitted. The resulting Observable will {@code onError} emitting
5042+
* a {@code BufferOverflowException} as soon as the buffer's capacity is exceeded, dropping all undelivered
5043+
* items, and unsubscribing from the source.
50445044
* <p>
50455045
* <img width="640" height="300" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/bp.obp.buffer.png" alt="">
50465046
* <dl>
50475047
* <dt><b>Scheduler:</b></dt>
50485048
* <dd>{@code onBackpressureBuffer} does not operate by default on a particular {@link Scheduler}.</dd>
50495049
* </dl>
50505050
*
5051-
* @return the source Observable modified to buffer items up to the given capacity.
5051+
* @return the source Observable modified to buffer items up to the given capacity
50525052
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Backpressure">RxJava wiki: Backpressure</a>
50535053
* @Beta
5054+
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
50545055
*/
50555056
@Beta
50565057
public final Observable<T> onBackpressureBuffer(long capacity) {
50575058
return lift(new OperatorOnBackpressureBuffer<T>(capacity));
50585059
}
50595060

50605061
/**
5061-
* Instructs an Observable that is emitting items faster than its observer can consume them to buffer
5062-
* up to a given amount of items until they can be emitted. The resulting Observable will {@code onError} emitting a
5063-
* {@link java.nio.BufferOverflowException} as soon as the buffer's capacity is exceeded, dropping all
5064-
* undelivered items, unsubscribing from the source, and notifying the producer with {@code onOverflow}.
5062+
* Instructs an Observable that is emitting items faster than its observer can consume them to buffer up to
5063+
* a given amount of items until they can be emitted. The resulting Observable will {@code onError} emitting
5064+
* a {@code BufferOverflowException} as soon as the buffer's capacity is exceeded, dropping all undelivered
5065+
* items, unsubscribing from the source, and notifying the producer with {@code onOverflow}.
50655066
* <p>
50665067
* <img width="640" height="300" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/bp.obp.buffer.png" alt="">
50675068
* <dl>
50685069
* <dt><b>Scheduler:</b></dt>
50695070
* <dd>{@code onBackpressureBuffer} does not operate by default on a particular {@link Scheduler}.</dd>
50705071
* </dl>
50715072
*
5072-
* @return the source Observable modified to buffer items up to the given capacity.
5073+
* @return the source Observable modified to buffer items up to the given capacity
50735074
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Backpressure">RxJava wiki: Backpressure</a>
5075+
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
50745076
* @Beta
50755077
*/
50765078
@Beta

0 commit comments

Comments
 (0)