Skip to content

Javadoc updates for RXJava Issue 6289 #6308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2018
+47 −0
Merged

Javadoc updates for RXJava Issue 6289 #6308

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f0450b
Javadoc updates for RXJava Issue 6289
pkamath2 Nov 16, 2018
00d7158
With review comments on issue 6289
pkamath2 Nov 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions src/main/java/io/reactivex/Flowable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10345,6 +10345,17 @@ public final Disposable forEachWhile(final Predicate<? super T> onNext, final Co
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedPublisher}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code Publisher}s honor backpressure and the source {@code Publisher}
Expand Down Expand Up @@ -10385,6 +10396,17 @@ public final <K> Flowable<GroupedFlowable<K, T>> groupBy(Function<? super T, ? e
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedPublisher}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code Publisher}s honor backpressure and the source {@code Publisher}
Expand Down Expand Up @@ -10428,6 +10450,17 @@ public final <K> Flowable<GroupedFlowable<K, T>> groupBy(Function<? super T, ? e
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedPublisher}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code Publisher}s honor backpressure and the source {@code Publisher}
Expand Down Expand Up @@ -10473,6 +10506,17 @@ public final <K, V> Flowable<GroupedFlowable<K, V>> groupBy(Function<? super T,
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedPublisher}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code Publisher}s honor backpressure and the source {@code Publisher}
Expand Down Expand Up @@ -10521,6 +10565,17 @@ public final <K, V> Flowable<GroupedFlowable<K, V>> groupBy(Function<? super T,
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedPublisher}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code Publisher}s honor backpressure and the source {@code Publisher}
Expand Down Expand Up @@ -10617,6 +10672,17 @@ public final <K, V> Flowable<GroupedFlowable<K, V>> groupBy(Function<? super T,
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
* {@code GroupedFlowable}s that do not concern you. Instead, you can signal to them that they may
* discard their buffers by applying an operator like {@link #ignoreElements} to them.
* <p>
* By default, a {@link GroupedFlowable} buffers only {@code Flowable.BUFFER_SIZE} items to emit.
* So, it is important that a subscription to consume these items begin as soon as the {@link GroupedFlowable}s are created.
* If not, it may result in groups upstream not being consumed.
* Typically {@code flatMap} or {@code concatMapEager} can be used to ensure all {@link GroupedFlowable} items are consumed.
* <p>
* Note that, while using {@link #flatMap(Function, int)} or {@link #concatMapEager(Function, int, int)} operators,
* we need to ensure that the maximum concurrency parameter is a value greater than
* or equal to the number of expected groups, or {@code Integer.MAX_VALUE} if the number of expected groups is unknown.
* Using the default maximum concurrency may also sometimes lead to starvation of unconsumed groups upstream.
*
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>Both the returned and its inner {@code GroupedFlowable}s honor backpressure and the source {@code Publisher}
Expand Down