diff --git a/src/main/java/io/reactivex/rxjava3/core/Completable.java b/src/main/java/io/reactivex/rxjava3/core/Completable.java index 7e788ea3b9..ee3af955a9 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Completable.java +++ b/src/main/java/io/reactivex/rxjava3/core/Completable.java @@ -165,7 +165,7 @@ public static Completable amb(@NonNull Iterable<@NonNull ? extends CompletableSo *
Scheduler:
*
{@code complete} does not operate by default on a particular {@link Scheduler}.
* - * @return a {@code Completable} instance that completes immediately + * @return the shared {@code Completable} instance */ @CheckReturnValue @NonNull @@ -183,7 +183,7 @@ public static Completable complete() { *
{@code concatArray} does not operate by default on a particular {@link Scheduler}.
* * @param sources the sources to concatenate - * @return the {@code Completable} instance which completes only when all sources complete + * @return the new {@code Completable} instance * @throws NullPointerException if {@code sources} is {@code null} */ @CheckReturnValue @@ -210,7 +210,7 @@ public static Completable concatArray(@NonNull CompletableSource... sources) { *
{@code concat} does not operate by default on a particular {@link Scheduler}.
* * @param sources the sources to concatenate - * @return the {@code Completable} instance which completes only when all sources complete + * @return the new {@code Completable} instance * @throws NullPointerException if {@code sources} is {@code null} */ @CheckReturnValue @@ -234,7 +234,7 @@ public static Completable concat(@NonNull Iterable<@NonNull ? extends Completabl *
{@code concat} does not operate by default on a particular {@link Scheduler}.
* * @param sources the sources to concatenate - * @return the {@code Completable} instance which completes only when all sources complete + * @return the new {@code Completable} instance * @throws NullPointerException if {@code sources} is {@code null} */ @CheckReturnValue @@ -258,7 +258,7 @@ public static Completable concat(@NonNull Publisher<@NonNull ? extends Completab * * @param sources the sources to concatenate * @param prefetch the number of sources to prefetch from the sources - * @return the {@code Completable} instance which completes only when all sources complete + * @return the new {@code Completable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code prefetch} is non-positive */ @@ -334,7 +334,7 @@ public static Completable create(@NonNull CompletableOnSubscribe source) { * * @param source the callback which will receive the {@link CompletableObserver} instances * when the {@code Completable} is subscribed to. - * @return the created {@code Completable} instance + * @return the new {@code Completable} instance * @throws NullPointerException if {@code source} is {@code null} * @throws IllegalArgumentException if {@code source} is a {@code Completable} */ @@ -358,7 +358,7 @@ public static Completable unsafeCreate(@NonNull CompletableSource source) { *
{@code defer} does not operate by default on a particular {@link Scheduler}.
* * @param completableSupplier the supplier that returns the {@code Completable} that will be subscribed to. - * @return the {@code Completable} instance + * @return the new {@code Completable} instance * @throws NullPointerException if {@code completableSupplier} is {@code null} */ @CheckReturnValue @@ -1008,7 +1008,7 @@ public static Completable timer(long delay, @NonNull TimeUnit unit, @NonNull Sch /** * Creates a {@link NullPointerException} instance and sets the given {@link Throwable} as its initial cause. * @param ex the {@code Throwable} instance to use as cause, not {@code null} (not verified) - * @return the created {@code NullPointerException} + * @return the new {@code NullPointerException} */ private static NullPointerException toNpe(Throwable ex) { NullPointerException npe = new NullPointerException("Actually not, but can't pass out an exception otherwise..."); @@ -1096,7 +1096,7 @@ public static Completable using( *
{@code wrap} does not operate by default on a particular {@link Scheduler}.
* * @param source the source to wrap - * @return the source or its wrapper {@code Completable} + * @return the new wrapped or cast {@code Completable} instance * @throws NullPointerException if {@code source} is {@code null} */ @CheckReturnValue @@ -1344,7 +1344,7 @@ public final Completable cache() { *
{@code compose} does not operate by default on a particular {@link Scheduler}.
* * @param transformer the transformer function, not {@code null} - * @return a {@code Completable} wrapping the {@code CompletableSource} returned by the function via {@link #wrap(CompletableSource)} + * @return the new {@code Completable} instance * @throws NullPointerException if {@code transformer} is {@code null} */ @CheckReturnValue @@ -1461,7 +1461,7 @@ public final Completable delay(long delay, @NonNull TimeUnit unit, @NonNull Sche * * @param delay the time to delay the subscription * @param unit the time unit of {@code delay} - * @return a {@code Completable} that delays the subscription to the upstream by the given amount + * @return the new {@code Completable} instance * @throws NullPointerException if {@code unit} is {@code null} * @since 3.0.0 * @see ReactiveX operators documentation: Delay @@ -1486,8 +1486,7 @@ public final Completable delaySubscription(long delay, @NonNull TimeUnit unit) { * @param delay the time to delay the subscription * @param unit the time unit of {@code delay} * @param scheduler the {@code Scheduler} on which the waiting and subscription will happen - * @return a {@code Completable} that delays the subscription to the upstream by a given - * amount of time, waiting and subscribing on the given {@code Scheduler} + * @return the new {@code Completable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @since 3.0.0 * @see ReactiveX operators documentation: Delay @@ -1998,8 +1997,7 @@ public final Completable onErrorResumeNext(@NonNull Function{@code onTerminateDetach} does not operate by default on a particular {@link Scheduler}. * *

History: 2.1.5 - experimental - * @return a {@code Completable} which {@code null}s out references to the upstream producer and downstream {@code CompletableObserver} if - * the sequence is terminated or downstream calls {@code dispose()} + * @return the new {@code Completable} instance * @since 2.2 */ @CheckReturnValue @@ -2336,7 +2334,7 @@ public final Completable hide() { *

Scheduler:
*
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* - * @return the {@code Disposable} that allows disposing the subscription + * @return the new {@code Disposable} that can be used for disposing the subscription at any time */ @SchedulerSupport(SchedulerSupport.NONE) @NonNull @@ -2420,7 +2418,7 @@ public final void subscribe(@NonNull CompletableObserver observer) { * * @param onComplete the {@link Action} that is called if the {@code Completable} completes normally * @param onError the {@link Consumer} that is called if this {@code Completable} emits an error - * @return the {@link Disposable} that can be used for disposing the subscription asynchronously + * @return the new {@link Disposable} that can be used for disposing the subscription at any time * @throws NullPointerException if {@code onComplete} or {@code onError} is {@code null} */ @CheckReturnValue @@ -2449,7 +2447,7 @@ public final Disposable subscribe(@NonNull Action onComplete, @NonNull Consumer< *
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* * @param onComplete the {@code Action} called when this {@code Completable} completes normally - * @return the {@link Disposable} that allows disposing the subscription + * @return the new {@link Disposable} that can be used for disposing the subscription at any time * @throws NullPointerException if {@code onComplete} is {@code null} */ @CheckReturnValue @@ -2691,8 +2689,7 @@ public final Flowable toFlowable() { * * * @param the value type - * @return a {@code Maybe} that only calls {@code onComplete} or {@code onError}, based on which one is - * called by the current {@code Completable}. + * @return the new {@code Maybe} instance */ @CheckReturnValue @SuppressWarnings("unchecked") diff --git a/src/main/java/io/reactivex/rxjava3/core/Flowable.java b/src/main/java/io/reactivex/rxjava3/core/Flowable.java index c1f4338cd2..54bc24fca0 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Flowable.java +++ b/src/main/java/io/reactivex/rxjava3/core/Flowable.java @@ -174,8 +174,7 @@ public abstract class Flowable<@NonNull T> implements Publisher { * @param sources * an {@code Iterable} of {@code Publisher}s sources competing to react first. A subscription to each {@code Publisher} will * occur in the same order as in this {@code Iterable}. - * @return a {@code Flowable} that emits the same sequence as whichever of the source {@code Publisher}s first - * emitted an item or sent a termination notification + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -205,8 +204,7 @@ public static Flowable amb(@NonNull Iterable<@NonNull ? extends Publisher * @param sources * an array of {@code Publisher} sources competing to react first. A subscription to each {@code Publisher} will * occur in the same order as in this array. - * @return a {@code Flowable} that emits the same sequence as whichever of the source {@code Publisher}s first - * emitted an item or sent a termination notification + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -271,8 +269,7 @@ public static int bufferSize() { * the collection of source {@code Publisher}s * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -319,8 +316,7 @@ public static int bufferSize() { * the aggregation function used to combine the items emitted by the source {@code Publisher}s * @param bufferSize * the internal buffer size and prefetch amount applied to every source {@code Flowable} - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -372,8 +368,7 @@ public static Flowable combineLatestArray(@NonNull Publisher<@NonNull * the collection of source {@code Publisher}s * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -421,8 +416,7 @@ public static Flowable combineLatestArray(@NonNull Publisher<@NonNull * the aggregation function used to combine the items emitted by the source {@code Publisher}s * @param bufferSize * the internal buffer size and prefetch amount applied to every source {@code Flowable} - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -472,8 +466,7 @@ public static Flowable combineLatest(@NonNull Iterable<@NonNull ? exte * the collection of source {@code Publisher}s * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -522,8 +515,7 @@ public static Flowable combineLatest(@NonNull Iterable<@NonNull ? exte * the aggregation function used to combine the items emitted by the source {@code Publisher}s * @param bufferSize * the internal buffer size and prefetch amount applied to every source {@code Flowable} - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -577,8 +569,7 @@ public static Flowable combineLatest(@NonNull Iterable<@NonNull ? exte * the collection of source {@code Publisher}s * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -627,8 +618,7 @@ public static Flowable combineLatest(@NonNull Iterable<@NonNull ? exte * the aggregation function used to combine the items emitted by the source {@code Publisher}s * @param bufferSize * the internal buffer size and prefetch amount applied to every source {@code Flowable} - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -673,8 +663,7 @@ public static Flowable combineLatestDelayError(@NonNull Iterable<@NonN * the second source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -723,8 +712,7 @@ public static Flowable combineLatest( * the third source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -778,8 +766,7 @@ public static Flowable combineLatest( * the fourth source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -838,8 +825,7 @@ public static Flowable combineLatest( * the fifth source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -903,8 +889,7 @@ public static Flowable combineLatest( * the sixth source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -972,8 +957,7 @@ public static Flowable combineLatest( * the seventh source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7} or {@code combiner} is {@code null} @@ -1047,8 +1031,7 @@ public static Flowable combineLatest( * the eighth source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8} or {@code combiner} is {@code null} @@ -1126,8 +1109,7 @@ public static Flowable combineLatest( * the ninth source {@code Publisher} * @param combiner * the aggregation function used to combine the items emitted by the source {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of combining the items emitted by the source - * {@code Publisher}s by means of the given aggregation function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8}, {@code source9} @@ -1207,8 +1189,7 @@ public static Flowable concat(@NonNull Iterable<@NonNull ? extends Publis * @param the common element base type * @param sources * a {@code Publisher} that emits {@code Publisher}s - * @return a {@code Flowable} that emits items all of the items emitted by the {@code Publisher}s emitted by - * {@code Publisher}s, one after the other, without interleaving them + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1240,8 +1221,7 @@ public static Flowable concat(@NonNull Publisher<@NonNull ? extends Publi * a {@code Publisher} that emits {@code Publisher}s * @param prefetch * the number of {@code Publisher}s to prefetch from the sources sequence. - * @return a {@code Flowable} that emits items all of the items emitted by the {@code Publisher}s emitted by - * {@code Publisher}s, one after the other, without interleaving them + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code prefetch} is non-positive * @see ReactiveX operators documentation: Concat @@ -1275,8 +1255,7 @@ public static Flowable concat(@NonNull Publisher<@NonNull ? extends Publi * a {@code Publisher} to be concatenated * @param source2 * a {@code Publisher} to be concatenated - * @return a {@code Flowable} that emits items emitted by the two source {@code Publisher}s, one after the other, - * without interleaving them + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1312,8 +1291,7 @@ public static Flowable concat(@NonNull Publisher<@NonNull ? extends T> so * a {@code Publisher} to be concatenated * @param source3 * a {@code Publisher} to be concatenated - * @return a {@code Flowable} that emits items emitted by the three source {@code Publisher}s, one after the other, - * without interleaving them + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1354,8 +1332,7 @@ public static Flowable concat( * a {@code Publisher} to be concatenated * @param source4 * a {@code Publisher} to be concatenated - * @return a {@code Flowable} that emits items emitted by the four source {@code Publisher}s, one after the other, - * without interleaving them + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1884,8 +1861,7 @@ public static Flowable create(@NonNull FlowableOnSubscribe source, @No * resulting {@code Flowable} * @param * the type of the items emitted by the {@code Publisher} - * @return a {@code Flowable} whose {@code Subscriber}s' subscriptions trigger an invocation of the given - * {@code Publisher} factory function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see ReactiveX operators documentation: Defer */ @@ -1912,8 +1888,7 @@ public static Flowable defer(@NonNull Supplier * the type of the items (ostensibly) emitted by the {@link Publisher} - * @return a {@code Flowable} that emits no items to the {@code Subscriber} but immediately invokes the - * {@code Subscriber}'s {@link Subscriber#onComplete() onComplete} method + * @return the shared {@code Flowable} instance * @see ReactiveX operators documentation: Empty */ @CheckReturnValue @@ -1941,8 +1916,7 @@ public static Flowable empty() { * a {@link Supplier} factory to return a {@link Throwable} for each individual {@code Subscriber} * @param * the type of the items (ostensibly) emitted by the {@link Publisher} - * @return a {@code Flowable} that invokes the {@code Subscriber}'s {@link Subscriber#onError onError} method when - * the {@code Subscriber} subscribes to it + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -1971,8 +1945,7 @@ public static Flowable error(@NonNull Supplier suppl * the particular {@link Throwable} to pass to {@link Subscriber#onError onError} * @param * the type of the items (ostensibly) emitted by the {@link Publisher} - * @return a {@code Flowable} that invokes the {@code Subscriber}'s {@link Subscriber#onError onError} method when - * the {@code Subscriber} subscribes to it + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code throwable} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -2001,7 +1974,7 @@ public static Flowable error(@NonNull Throwable throwable) { * the array of elements * @param * the type of items in the array and the type of items to be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits each item in the source array + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: From */ @@ -2048,7 +2021,7 @@ public static Flowable error(@NonNull Throwable throwable) { * function only when a {@code Subscriber} subscribes to the {@code Publisher} that {@code fromCallable} returns * @param * the type of the item emitted by the {@code Publisher} - * @return a {@code Flowable} whose {@code Subscriber}s' subscriptions trigger an invocation of the given function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code callable} is {@code null} * @see #defer(Supplier) * @see #fromSupplier(Supplier) @@ -2091,7 +2064,7 @@ public static Flowable error(@NonNull Throwable throwable) { * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Flowable} - * @return a {@code Flowable} that emits the item from the source {@code Future} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code future} is {@code null} * @see ReactiveX operators documentation: From * @see #fromCompletionStage(CompletionStage) @@ -2137,7 +2110,7 @@ public static Flowable error(@NonNull Throwable throwable) { * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Flowable} - * @return a {@code Flowable} that emits the item from the source {@code Future} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code future} or {@code unit} is {@code null} * @see ReactiveX operators documentation: From * @see #fromCompletionStage(CompletionStage) @@ -2169,7 +2142,7 @@ public static Flowable error(@NonNull Throwable throwable) { * @param * the type of items in the {@code Iterable} sequence and the type of items to be emitted by the * resulting {@code Flowable} - * @return a {@code Flowable} that emits each item in the source {@code Iterable} sequence + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source} is {@code null} * @see ReactiveX operators documentation: From * @see #fromStream(Stream) @@ -2251,7 +2224,7 @@ public static Flowable fromPublisher(@NonNull Publisher<@NonNull ? extend * function only when a {@code Subscriber} subscribes to the {@code Publisher} that {@code fromSupplier} returns * @param * the type of the item emitted by the {@code Publisher} - * @return a {@code Flowable} whose {@code Subscriber}s' subscriptions trigger an invocation of the given function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see #defer(Supplier) * @see #fromCallable(Callable) @@ -2460,8 +2433,7 @@ public static Flowable generate(@NonNull Supplier initialState, @No * the period of time between emissions of the subsequent numbers * @param unit * the time unit for both {@code initialDelay} and {@code period} - * @return a {@code Flowable} that emits a 0L after the {@code initialDelay} and ever-increasing numbers after - * each {@code period} of time thereafter + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Interval * @since 1.0.12 @@ -2496,8 +2468,7 @@ public static Flowable interval(long initialDelay, long period, @NonNull T * the time unit for both {@code initialDelay} and {@code period} * @param scheduler * the {@code Scheduler} on which the waiting happens and items are emitted - * @return a {@code Flowable} that emits a 0L after the {@code initialDelay} and ever-increasing numbers after - * each {@code period} of time thereafter, while running on the given {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Interval * @since 1.0.12 @@ -2528,7 +2499,7 @@ public static Flowable interval(long initialDelay, long period, @NonNull T * the period size in time units (see below) * @param unit * time units to use for the interval size - * @return a {@code Flowable} that emits a sequential number each time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Interval */ @@ -2560,7 +2531,7 @@ public static Flowable interval(long period, @NonNull TimeUnit unit) { * time units to use for the interval size * @param scheduler * the {@code Scheduler} to use for scheduling the items - * @return a {@code Flowable} that emits a sequential number each time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Interval */ @@ -2668,7 +2639,7 @@ public static Flowable intervalRange(long start, long count, long initialD * the item to emit * @param * the type of that item - * @return a {@code Flowable} that emits {@code value} as a single item and then completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: Just * @see #just(Object, Object) @@ -2702,7 +2673,7 @@ public static Flowable intervalRange(long start, long count, long initialD * second item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1} or {@code item2} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -2736,7 +2707,7 @@ public static Flowable intervalRange(long start, long count, long initialD * third item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2} or {@code item3} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -2773,7 +2744,7 @@ public static Flowable intervalRange(long start, long count, long initialD * fourth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * or {@code item4} is {@code null} * @see ReactiveX operators documentation: Just @@ -2814,7 +2785,7 @@ public static Flowable intervalRange(long start, long count, long initialD * fifth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4} or {@code item5} is {@code null} * @see ReactiveX operators documentation: Just @@ -2858,7 +2829,7 @@ public static Flowable intervalRange(long start, long count, long initialD * sixth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5} or {@code item6} is {@code null} * @see ReactiveX operators documentation: Just @@ -2905,7 +2876,7 @@ public static Flowable intervalRange(long start, long count, long initialD * seventh item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6} * or {@code item7} is {@code null} @@ -2956,7 +2927,7 @@ public static Flowable intervalRange(long start, long count, long initialD * eighth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6}, * {@code item7} or {@code item8} is {@code null} @@ -3010,7 +2981,7 @@ public static Flowable intervalRange(long start, long count, long initialD * ninth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6}, * {@code item7}, {@code item8} or {@code item9} is {@code null} @@ -3067,7 +3038,7 @@ public static Flowable intervalRange(long start, long count, long initialD * tenth item * @param * the type of these items - * @return a {@code Flowable} that emits each item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6}, * {@code item7}, {@code item8}, {@code item9}, @@ -3129,8 +3100,7 @@ public static Flowable intervalRange(long start, long count, long initialD * the maximum number of {@code Publisher}s that may be subscribed to concurrently * @param bufferSize * the number of items to prefetch from each inner {@code Publisher} - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrency} or {@code bufferSize} is non-positive @@ -3182,8 +3152,7 @@ public static Flowable merge(@NonNull Iterable<@NonNull ? extends Publish * the maximum number of {@code Publisher}s that may be subscribed to concurrently * @param bufferSize * the number of items to prefetch from each inner {@code Publisher} - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrency} or {@code bufferSize} is non-positive @@ -3231,8 +3200,7 @@ public static Flowable mergeArray(int maxConcurrency, int bufferSize, @No * @param the common element base type * @param sources * the {@code Iterable} of {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Iterable) @@ -3280,8 +3248,7 @@ public static Flowable merge(@NonNull Iterable<@NonNull ? extends Publish * the {@code Iterable} of {@code Publisher}s * @param maxConcurrency * the maximum number of {@code Publisher}s that may be subscribed to concurrently - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrency} is less than or equal to 0 @@ -3330,8 +3297,7 @@ public static Flowable merge(@NonNull Iterable<@NonNull ? extends Publish * @param the common element base type * @param sources * a {@code Publisher} that emits {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of flattening the {@code Publisher}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Publisher) @@ -3379,8 +3345,7 @@ public static Flowable merge(@NonNull Publisher<@NonNull ? extends Publis * a {@code Publisher} that emits {@code Publisher}s * @param maxConcurrency * the maximum number of {@code Publisher}s that may be subscribed to concurrently - * @return a {@code Flowable} that emits items that are the result of flattening the {@code Publisher}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrency} is less than or equal to 0 @@ -3428,7 +3393,7 @@ public static Flowable merge(@NonNull Publisher<@NonNull ? extends Publis * @param the common element base type * @param sources * the array of {@code Publisher}s - * @return a {@code Flowable} that emits all of the items emitted by the {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeArrayDelayError(Publisher...) @@ -3476,7 +3441,7 @@ public static Flowable mergeArray(@NonNull Publisher<@NonNull ? extends T * a {@code Publisher} to be merged * @param source2 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Publisher, Publisher) @@ -3527,7 +3492,7 @@ public static Flowable merge(@NonNull Publisher<@NonNull ? extends T> sou * a {@code Publisher} to be merged * @param source3 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Publisher, Publisher, Publisher) @@ -3581,7 +3546,7 @@ public static Flowable merge(@NonNull Publisher<@NonNull ? extends T> sou * a {@code Publisher} to be merged * @param source4 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Publisher, Publisher, Publisher, Publisher) @@ -3625,8 +3590,7 @@ public static Flowable merge( * @param the common element base type * @param sources * the {@code Iterable} of {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3667,8 +3631,7 @@ public static Flowable mergeDelayError(@NonNull Iterable<@NonNull ? exten * the maximum number of {@code Publisher}s that may be subscribed to concurrently * @param bufferSize * the number of items to prefetch from each inner {@code Publisher} - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Merge @@ -3710,8 +3673,7 @@ public static Flowable mergeDelayError(@NonNull Iterable<@NonNull ? exten * the maximum number of {@code Publisher}s that may be subscribed to concurrently * @param bufferSize * the number of items to prefetch from each inner {@code Publisher} - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Merge @@ -3752,8 +3714,7 @@ public static Flowable mergeArrayDelayError(int maxConcurrency, int buffe * the {@code Iterable} of {@code Publisher}s * @param maxConcurrency * the maximum number of {@code Publisher}s that may be subscribed to concurrently - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: Merge @@ -3792,8 +3753,7 @@ public static Flowable mergeDelayError(@NonNull Iterable<@NonNull ? exten * @param the common element base type * @param sources * a {@code Publisher} that emits {@code Publisher}s - * @return a {@code Flowable} that emits all of the items emitted by the {@code Publisher}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3832,8 +3792,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * a {@code Publisher} that emits {@code Publisher}s * @param maxConcurrency * the maximum number of {@code Publisher}s that may be subscribed to concurrently - * @return a {@code Flowable} that emits all of the items emitted by the {@code Publisher}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: Merge @@ -3872,8 +3831,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * @param the common element base type * @param sources * the array of {@code Publisher}s - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3913,7 +3871,7 @@ public static Flowable mergeArrayDelayError(@NonNull Publisher<@NonNull ? * a {@code Publisher} to be merged * @param source2 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the two source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3957,7 +3915,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * a {@code Publisher} to be merged * @param source3 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -4004,7 +3962,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * a {@code Publisher} to be merged * @param source4 * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the source {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -4038,7 +3996,7 @@ public static Flowable mergeDelayError( * * @param * the type of items (not) emitted by the {@code Publisher} - * @return a {@code Flowable} that never emits any items or sends any notifications to a {@code Subscriber} + * @return the shared {@code Flowable} instance * @see ReactiveX operators documentation: Never */ @CheckReturnValue @@ -4065,7 +4023,7 @@ public static Flowable never() { * the value of the first {@code Integer} in the sequence * @param count * the number of sequential {@code Integer}s to generate - * @return a {@code Flowable} that emits a range of sequential {@code Integer}s + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code count} is less than zero, or if {@code start} + {@code count} − 1 exceeds * {@link Integer#MAX_VALUE} @@ -4106,7 +4064,7 @@ public static Flowable range(int start, int count) { * the value of the first {@code Long} in the sequence * @param count * the number of sequential {@code Long}s to generate - * @return a {@code Flowable} that emits a range of sequential {@code Long}s + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code count} is less than zero, or if {@code start} + {@code count} − 1 exceeds * {@link Long#MAX_VALUE} @@ -4156,7 +4114,7 @@ public static Flowable rangeLong(long start, long count) { * the second {@code Publisher} to compare * @param * the type of items emitted by each {@code Publisher} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -4190,8 +4148,7 @@ public static Single sequenceEqual(@NonNull Publisher<@NonNull ? ex * a function used to compare items emitted by each {@code Publisher} * @param * the type of items emitted by each {@code Publisher} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two {@code Publisher} sequences - * are the same according to the specified function + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code isEqual} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -4228,8 +4185,7 @@ public static Single sequenceEqual(@NonNull Publisher<@NonNull ? ex * the number of items to prefetch from the first and second source {@code Publisher} * @param * the type of items emitted by each {@code Publisher} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two {@code Publisher} sequences - * are the same according to the specified function + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code isEqual} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SequenceEqual @@ -4268,7 +4224,7 @@ public static Single sequenceEqual(@NonNull Publisher<@NonNull ? ex * the number of items to prefetch from the first and second source {@code Publisher} * @param * the type of items emitted by each {@code Publisher} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SequenceEqual @@ -4309,8 +4265,7 @@ public static Single sequenceEqual(@NonNull Publisher<@NonNull ? ex * the source {@code Publisher} that emits {@code Publisher}s * @param bufferSize * the number of items to prefetch from the inner {@code Publisher}s - * @return a {@code Flowable} that emits the items emitted by the {@code Publisher} most recently emitted by the source - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Switch @@ -4350,8 +4305,7 @@ public static Flowable switchOnNext(@NonNull Publisher<@NonNull ? extends * @param the item type * @param sources * the source {@code Publisher} that emits {@code Publisher}s - * @return a {@code Flowable} that emits the items emitted by the {@code Publisher} most recently emitted by the source - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Switch */ @@ -4391,8 +4345,7 @@ public static Flowable switchOnNext(@NonNull Publisher<@NonNull ? extends * @param the item type * @param sources * the source {@code Publisher} that emits {@code Publisher}s - * @return a {@code Flowable} that emits the items emitted by the {@code Publisher} most recently emitted by the source - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Switch * @since 2.0 @@ -4434,8 +4387,7 @@ public static Flowable switchOnNextDelayError(@NonNull Publisher<@NonNull * the source {@code Publisher} that emits {@code Publisher}s * @param prefetch * the number of items to prefetch from the inner {@code Publisher}s - * @return a {@code Flowable} that emits the items emitted by the {@code Publisher} most recently emitted by the source - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code prefetch} is non-positive * @see ReactiveX operators documentation: Switch @@ -4465,7 +4417,7 @@ public static Flowable switchOnNextDelayError(@NonNull Publisher<@NonNull * the initial delay before emitting a single {@code 0L} * @param unit * time units to use for {@code delay} - * @return a {@code Flowable} that emits {@code 0L} after a specified delay, and then completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Timer */ @@ -4496,8 +4448,7 @@ public static Flowable timer(long delay, @NonNull TimeUnit unit) { * time units to use for {@code delay} * @param scheduler * the {@code Scheduler} to use for scheduling the item - * @return a {@code Flowable} that emits {@code 0L} after a specified delay, on a specified {@code Scheduler}, and then - * completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timer */ @@ -4565,7 +4516,7 @@ public static Flowable unsafeCreate(@NonNull Publisher onSubscribe) { * the factory function to create a {@code Publisher} * @param resourceDisposer * the function that will dispose of the resource - * @return the {@code Flowable} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code resourceSupplier}, {@code sourceSupplier} or {@code resourceDisposer} is {@code null} * @see ReactiveX operators documentation: Using */ @@ -4607,7 +4558,7 @@ public static Flowable using( * or just before the emission of a terminal event ({@code onComplete} or {@code onError}). * If {@code false} the resource disposal will happen either on a {@code cancel()} call after the upstream is disposed * or just after the emission of a terminal event ({@code onComplete} or {@code onError}). - * @return the {@code Flowable} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code resourceSupplier}, {@code sourceSupplier} or {@code resourceDisposer} is {@code null} * @see ReactiveX operators documentation: Using * @since 2.0 @@ -4668,7 +4619,7 @@ public static Flowable using( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4728,7 +4679,7 @@ public static Flowable zip(@NonNull Iterable<@NonNull ? extends Publis * the number of elements to prefetch from each source {@code Publisher} * @param the common source value type * @param the zipped result type - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -4791,7 +4742,7 @@ public static Flowable zip(@NonNull Iterable<@NonNull ? extends Publis * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results * in an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4854,7 +4805,7 @@ public static Flowable zip( * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results * in an item that will be emitted by the resulting {@code Flowable} * @param delayError delay errors from any of the source {@code Publisher}s till the other terminates - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4918,7 +4869,7 @@ public static Flowable zip( * in an item that will be emitted by the resulting {@code Flowable} * @param delayError delay errors from any of the source {@code Publisher}s till the other terminates * @param bufferSize the number of elements to prefetch from each source {@code Publisher} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -4985,7 +4936,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -5055,7 +5006,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -5131,7 +5082,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -5210,7 +5161,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6} * or {@code zipper} is {@code null} @@ -5294,7 +5245,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7} or {@code zipper} is {@code null} @@ -5383,7 +5334,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8} or {@code zipper} is {@code null} @@ -5476,7 +5427,7 @@ public static Flowable zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code Publisher}s, results in * an item that will be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8}, {@code source9} @@ -5552,7 +5503,7 @@ public static Flowable zip( * delay errors signaled by any of the source {@code Publisher} until all {@code Publisher}s terminate * @param bufferSize * the number of elements to prefetch from each source {@code Publisher} - * @return a {@code Flowable} that emits the zipped results + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -5592,8 +5543,7 @@ public static Flowable zipArray(@NonNull FunctionReactiveX operators documentation: All */ @@ -5622,8 +5572,7 @@ public final Single all(@NonNull Predicate predicate) { * @param other * a {@code Publisher} competing to react first. A subscription to this provided {@code Publisher} will occur after subscribing * to the current {@code Flowable}. - * @return a {@code Flowable} that emits the same sequence as whichever of this or the other {@code Publisher} first - * emitted an item or sent a termination notification + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -5655,8 +5604,7 @@ public final Flowable ambWith(@NonNull Publisher<@NonNull ? extends T> other) * * @param predicate * the condition to test items emitted by the current {@code Flowable} - * @return a {@code Single} that emits a {@link Boolean} that indicates whether any item emitted by the current - * {@code Flowable} satisfies the {@code predicate} + * @return the new {@code Single} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: Contains */ @@ -5684,7 +5632,7 @@ public final Single any(@NonNull Predicate predicate) { * {@link Error}s are rethrown as they are. * * - * @return the first item emitted by this {@code Flowable} + * @return the new {@code Flowable} instance * @throws NoSuchElementException * if this {@code Flowable} emits no items * @see ReactiveX documentation: First @@ -5720,8 +5668,7 @@ public final T blockingFirst() { * * @param defaultItem * a default value to return if this {@code Flowable} emits no items - * @return the first item emitted by this {@code Flowable}, or the default value if it emits no - * items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX documentation: First */ @@ -5843,7 +5790,7 @@ public final void blockingForEach(@NonNull Consumer onNext, int buffe *
{@code blockingIterable} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Iterable} version of this {@code Flowable} + * @return the new {@code Iterable} instance * @see ReactiveX documentation: To */ @CheckReturnValue @@ -5868,7 +5815,7 @@ public final Iterable blockingIterable() { * * * @param bufferSize the number of items to prefetch from the current {@code Flowable} - * @return an {@code Iterable} version of this {@code Flowable} + * @return the new {@code Iterable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX documentation: To */ @@ -5898,7 +5845,7 @@ public final Iterable blockingIterable(int bufferSize) { * {@link Error}s are rethrown as they are. * * - * @return the last item emitted by this {@code Flowable} + * @return the new {@code Flowable} instance * @throws NoSuchElementException * if this {@code Flowable} emits no items * @see ReactiveX documentation: Last @@ -5936,8 +5883,7 @@ public final T blockingLast() { * * @param defaultItem * a default value to return if this {@code Flowable} emits no items - * @return the last item emitted by the {@code Flowable}, or the default value if it emits no - * items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX documentation: Last */ @@ -5970,7 +5916,7 @@ public final T blockingLast(@NonNull T defaultItem) { *
{@code blockingLatest} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Iterable} that always returns the latest item emitted by this {@code Flowable} + * @return the new {@code Iterable} instance * @see ReactiveX documentation: First */ @CheckReturnValue @@ -5997,8 +5943,7 @@ public final Iterable blockingLatest() { * @param initialItem * the initial item that the {@code Iterable} sequence will yield if this * {@code Flowable} has not yet emitted an item - * @return an {@code Iterable} that on each iteration returns the item that this {@code Flowable} - * has most recently emitted + * @return the new {@code Iterable} instance * @see ReactiveX documentation: First */ @CheckReturnValue @@ -6022,8 +5967,7 @@ public final Iterable blockingMostRecent(@NonNull T initialItem) { *
{@code blockingNext} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Iterable} that blocks upon each iteration until this {@code Flowable} emits - * a new item, whereupon the {@code Iterable} returns that item + * @return the new {@code Iterable} instance * @see ReactiveX documentation: TakeLast */ @CheckReturnValue @@ -6051,7 +5995,7 @@ public final Iterable blockingNext() { * {@link Error}s are rethrown as they are. * * - * @return the single item emitted by this {@code Flowable} + * @return the new {@code Flowable} instance * @see ReactiveX documentation: First */ @CheckReturnValue @@ -6082,8 +6026,7 @@ public final T blockingSingle() { * * @param defaultItem * a default value to return if this {@code Flowable} emits no items - * @return the single item emitted by this {@code Flowable}, or the default value if it emits no - * items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX documentation: First */ @@ -6114,7 +6057,7 @@ public final T blockingSingle(@NonNull T defaultItem) { *
{@code toFuture} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Future} that expects a single item to be emitted by this {@code Flowable} + * @return the new {@code Future} instance * @see ReactiveX documentation: To */ @CheckReturnValue @@ -6367,8 +6310,7 @@ public final void blockingSubscribe(@NonNull Subscriber<@NonNull ? super T> subs * * @param count * the maximum number of items in each buffer before it should be emitted - * @return a {@code Flowable} that emits connected, non-overlapping buffers, each containing at most - * {@code count} items from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer */ @@ -6403,8 +6345,7 @@ public final Flowable> buffer(int count) { * how many items emitted by the current {@code Flowable} should be skipped before starting a new * buffer. Note that when {@code skip} and {@code count} are equal, this is the same operation as * {@link #buffer(int)}. - * @return a {@code Flowable} that emits buffers for every {@code skip} item from the current {@code Flowable} and - * containing at most {@code count} items + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Buffer */ @@ -6443,8 +6384,7 @@ public final Flowable> buffer(int count, int skip) { * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return a {@code Flowable} that emits buffers for every {@code skip} item from the current {@code Flowable} and - * containing at most {@code count} items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6483,8 +6423,7 @@ public final > Flowable buffer(int count, int * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return a {@code Flowable} that emits connected, non-overlapping buffers, each containing at most - * {@code count} items from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6520,8 +6459,7 @@ public final > Flowable buffer(int count, @No * the period of time after which a new buffer will be created * @param unit * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments - * @return a {@code Flowable} that emits new buffers of items emitted by the current {@code Flowable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6559,8 +6497,7 @@ public final Flowable> buffer(long timespan, long timeskip, @NonNull Tim * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments * @param scheduler * the {@code Scheduler} to use when determining the end and start of a buffer - * @return a {@code Flowable} that emits new buffers of items emitted by the current {@code Flowable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6602,8 +6539,7 @@ public final Flowable> buffer(long timespan, long timeskip, @NonNull Tim * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return a {@code Flowable} that emits new buffers of items emitted by the current {@code Flowable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code bufferSupplier} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6641,8 +6577,7 @@ public final > Flowable buffer(long timespan, * buffer * @param unit * the unit of time that applies to the {@code timespan} argument - * @return a {@code Flowable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Flowable} within a fixed duration + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6678,9 +6613,7 @@ public final Flowable> buffer(long timespan, @NonNull TimeUnit unit) { * the unit of time which applies to the {@code timespan} argument * @param count * the maximum size of each buffer before it is emitted - * @return a {@code Flowable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Flowable}, after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6720,9 +6653,7 @@ public final Flowable> buffer(long timespan, @NonNull TimeUnit unit, int * the {@code Scheduler} to use when determining the end and start of a buffer * @param count * the maximum size of each buffer before it is emitted - * @return a {@code Flowable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Flowable} after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6768,9 +6699,7 @@ public final Flowable> buffer(long timespan, @NonNull TimeUnit unit, @No * as the buffer * @param restartTimerOnMaxSize if {@code true}, the time window is restarted when the max capacity of the current buffer * is reached - * @return a {@code Flowable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Flowable} after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6815,8 +6744,7 @@ public final > Flowable buffer( * the unit of time which applies to the {@code timespan} argument * @param scheduler * the {@code Scheduler} to use when determining the end and start of a buffer - * @return a {@code Flowable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Flowable} within a fixed duration + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6851,8 +6779,7 @@ public final Flowable> buffer(long timespan, @NonNull TimeUnit unit, @No * @param closingIndicator * the {@link Function} that is used to produce a {@code Publisher} for every buffer created. When this * {@code Publisher} emits an item, the associated buffer is emitted. - * @return a {@code Flowable} that emits buffers, containing items from the current {@code Flowable}, that are created - * and closed when the specified {@code Publisher}s emit items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6893,8 +6820,7 @@ public final Flowable> buffer( * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return a {@code Flowable} that emits buffers, containing items from the current {@code Flowable}, that are created - * and closed when the specified {@code Publisher}s emit items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code openingIndicator}, {@code closingIndicator} or {@code bufferSupplier} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6934,8 +6860,7 @@ public final > Flowable b * the boundary value type (ignored) * @param boundaryIndicator * the boundary {@code Publisher} - * @return a {@code Flowable} that emits buffered items from the current {@code Flowable} when the boundary {@code Publisher} - * emits an item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @see #buffer(Publisher, int) * @see ReactiveX operators documentation: Buffer @@ -6972,8 +6897,7 @@ public final Flowable> buffer(@NonNull Publisher boundaryIndicato * the boundary {@code Publisher} * @param initialCapacity * the initial capacity of each buffer chunk - * @return a {@code Flowable} that emits buffered items from the current {@code Flowable} when the boundary {@code Publisher} - * emits an item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @throws IllegalArgumentException if {@code initialCapacity} is non-positive * @see ReactiveX operators documentation: Buffer @@ -7014,8 +6938,7 @@ public final Flowable> buffer(@NonNull Publisher boundaryIndicato * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return a {@code Flowable} that emits buffered items from the current {@code Flowable} when the boundary {@code Publisher} - * emits an item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code boundaryIndicator} or {@code bufferSupplier} is {@code null} * @see #buffer(Publisher, int) * @see ReactiveX operators documentation: Buffer @@ -7077,8 +7000,7 @@ public final > Flowable buffer(@NonNull Pu *
{@code cache} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that, when first subscribed to, caches all of its items and notifications for the - * benefit of subsequent subscribers + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Replay * @see #takeUntil(Predicate) * @see #takeUntil(Publisher) @@ -7142,8 +7064,7 @@ public final Flowable cache() { * {@link #replay(int)} in combination with {@link ConnectableFlowable#autoConnect()} or similar. * * @param initialCapacity hint for number of items to cache (for optimizing underlying data structure) - * @return a {@code Flowable} that, when first subscribed to, caches all of its items and notifications for the - * benefit of subsequent subscribers + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code initialCapacity} is non-positive * @see ReactiveX operators documentation: Replay * @see #takeUntil(Predicate) @@ -7175,8 +7096,7 @@ public final Flowable cacheWithInitialCapacity(int initialCapacity) { * @param clazz * the target class type that {@code cast} will cast the items emitted by the current {@code Flowable} * into before emitting them from the resulting {@code Flowable} - * @return a {@code Flowable} that emits each item from the current {@code Flowable} after converting it to the - * specified type + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code clazz} is {@code null} * @see ReactiveX operators documentation: Map */ @@ -7214,8 +7134,7 @@ public final Flowable cast(@NonNull Class clazz) { * @param collector * a function that accepts the {@code state} and an emitted item, and modifies {@code state} * accordingly - * @return a {@code Single} that emits the result of collecting the values emitted by the current {@code Flowable} - * into a single mutable data structure + * @return the new {@code Single} instance * @throws NullPointerException if {@code initialItemSupplier} or {@code collector} is {@code null} * @see ReactiveX operators documentation: Reduce * @see #collect(Collector) @@ -7255,8 +7174,7 @@ public final Single collect(@NonNull Supplier initialItemSup * @param collector * a function that accepts the {@code state} and an emitted item, and modifies {@code state} * accordingly - * @return a {@code Single} that emits the result of collecting the values emitted by the current {@code Flowable} - * into a single mutable data structure + * @return the new {@code Single} instance * @throws NullPointerException if {@code initialItem} or {@code collector} is {@code null} * @see ReactiveX operators documentation: Reduce */ @@ -7288,7 +7206,7 @@ public final Single collect(@NonNull Supplier initialItemSup * * @param the value type of the output {@code Publisher} * @param composer implements the function that transforms the current {@code Flowable} - * @return the current {@code Flowable}, transformed by the transformer function + * @return the new composed {@code Flowable} instance * @throws NullPointerException if {@code composer} is {@code null} * @see RxJava wiki: Implementing Your Own Operators */ @@ -7326,8 +7244,7 @@ public final Flowable compose(@NonNull FlowableTransformerReactiveX operators documentation: FlatMap */ @@ -7366,8 +7283,7 @@ public final Flowable concatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -7419,8 +7335,7 @@ public final Flowable concatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -7455,7 +7370,7 @@ public final Flowable concatMap(@NonNull Function Flowable concatMapEagerDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -7936,8 +7850,7 @@ public final Flowable concatMapIterable(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -7971,7 +7884,7 @@ public final Flowable concatMapIterable(@NonNull Function Flowable concatMapMaybe(@NonNull Function Flowable concatMapMaybe(@NonNull Function Flowable concatMapMaybeDelayError(@NonNull Function Flowable concatMapMaybeDelayError(@NonNull Function Flowable concatMapMaybeDelayError(@NonNull Function Flowable concatMapSingle(@NonNull Function Flowable concatMapSingle(@NonNull Function Flowable concatMapSingleDelayError(@NonNull Function Flowable concatMapSingleDelayError(@NonNull Function Flowable concatMapSingleDelayError(@NonNull FunctionReactiveX operators documentation: Concat */ @@ -8460,8 +8372,7 @@ public final Flowable concatWith(@NonNull CompletableSource other) { * * @param item * the item to search for in the emissions from the current {@code Flowable} - * @return a {@code Single} that emits {@code true} if the specified item is emitted by the current {@code Flowable}, - * or {@code false} if the current {@code Flowable} completes without emitting that item + * @return the new {@code Single} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: Contains */ @@ -8487,8 +8398,7 @@ public final Single contains(@NonNull Object item) { *
{@code count} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a single item: the number of items emitted by the current {@code Flowable} as a - * 64-bit {@code Long} item + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Count */ @CheckReturnValue @@ -8524,8 +8434,7 @@ public final Single count() { * the debounce value type (ignored) * @param debounceIndicator * function to retrieve a sequence that indicates the throttle duration for each item - * @return a {@code Flowable} that omits items emitted by the current {@code Flowable} that are followed by another item - * within a computed debounce duration + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code debounceIndicator} is {@code null} * @see ReactiveX operators documentation: Debounce * @see RxJava wiki: Backpressure @@ -8568,8 +8477,7 @@ public final Flowable debounce(@NonNull FunctionReactiveX operators documentation: Debounce * @see RxJava wiki: Backpressure @@ -8614,8 +8522,7 @@ public final Flowable debounce(long timeout, @NonNull TimeUnit unit) { * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle the timeout for each * item - * @return a {@code Flowable} that filters out items from the current {@code Flowable} that are too quickly followed by - * newer items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Debounce * @see RxJava wiki: Backpressure @@ -8648,8 +8555,7 @@ public final Flowable debounce(long timeout, @NonNull TimeUnit unit, @NonNull * * @param defaultItem * the item to emit if the current {@code Flowable} emits no items - * @return a {@code Flowable} that emits either the specified default item if the current {@code Flowable} emits no - * items, or the items emitted by the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: DefaultIfEmpty */ @@ -8685,8 +8591,7 @@ public final Flowable defaultIfEmpty(@NonNull T defaultItem) { * a function that returns a {@code Publisher} for each item emitted by the current {@code Flowable}, which is * then used to delay the emission of that item by the resulting {@code Flowable} until the {@code Publisher} * returned from {@code itemDelay} emits an item - * @return a {@code Flowable} that delays the emissions of the current {@code Flowable} via another {@code Publisher} on a - * per-item basis + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code itemDelayIndicator} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8715,7 +8620,7 @@ public final Flowable delay(@NonNull FunctionReactiveX operators documentation: Delay */ @@ -8746,7 +8651,7 @@ public final Flowable delay(long delay, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, the upstream exception is signaled with the given delay, after all preceding normal elements, * if {@code false}, the upstream exception is signaled immediately - * @return the current {@code Flowable} shifted in time by the specified delay + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8776,7 +8681,7 @@ public final Flowable delay(long delay, @NonNull TimeUnit unit, boolean delay * the time unit of {@code delay} * @param scheduler * the {@code Scheduler} to use for delaying - * @return the current {@code Flowable} shifted in time by the specified delay + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8809,7 +8714,7 @@ public final Flowable delay(long delay, @NonNull TimeUnit unit, @NonNull Sche * @param delayError * if {@code true}, the upstream exception is signaled with the given delay, after all preceding normal elements, * if {@code false}, the upstream exception is signaled immediately - * @return the current {@code Flowable} shifted in time by the specified delay + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8852,8 +8757,7 @@ public final Flowable delay(long delay, @NonNull TimeUnit unit, @NonNull Sche * a function that returns a {@code Publisher} for each item emitted by the current {@code Flowable}, which is * then used to delay the emission of that item by the resulting {@code Flowable} until the {@code Publisher} * returned from {@code itemDelay} emits an item - * @return a {@code Flowable} that delays the subscription and emissions of the current {@code Flowable} via another - * {@code Publisher} on a per-item basis + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Delay */ @CheckReturnValue @@ -8879,8 +8783,7 @@ public final Flowable delay(@NonNull Publisher subscriptionIndicato * @param the value type of the other {@code Publisher}, irrelevant * @param subscriptionIndicator the other {@code Publisher} that should trigger the subscription * to this {@code Publisher}. - * @return a {@code Flowable} that delays the subscription to this {@code Publisher} - * until the other {@code Publisher} emits an element or completes normally. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code subscriptionIndicator} is {@code null} * @since 2.0 */ @@ -8908,7 +8811,7 @@ public final Flowable delaySubscription(@NonNull Publisher subscriptio * the time to delay the subscription * @param unit * the time unit of {@code delay} - * @return a {@code Flowable} that delays the subscription to the current {@code Flowable} by the given amount + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8938,8 +8841,7 @@ public final Flowable delaySubscription(long delay, @NonNull TimeUnit unit) { * the time unit of {@code delay} * @param scheduler * the {@code Scheduler} on which the waiting and subscription will happen - * @return a {@code Flowable} that delays the subscription to the current {@code Flowable} by a given - * amount, waiting and subscribing on the given {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8996,8 +8898,7 @@ public final Flowable delaySubscription(long delay, @NonNull TimeUnit unit, @ * @param the output value type * @param selector function that returns the upstream item and should return a {@code Notification} to signal * the corresponding {@code Subscriber} event to the downstream. - * @return a {@code Flowable} that emits the items and notifications embedded in the {@code Notification} objects - * selected from the items emitted by the source {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Dematerialize * @since 3.0.0 @@ -9038,8 +8939,7 @@ public final Flowable dematerialize(@NonNull Function<@NonNull ? super T, *
{@code distinct} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits only those items emitted by the current {@code Flowable} that are distinct from - * each other + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Distinct * @see #distinct(Function) * @see #distinct(Function, Supplier) @@ -9085,7 +8985,7 @@ public final Flowable distinct() { * @param keySelector * a function that projects an emitted item to a key value that is used to decide whether an item * is distinct from another one or not - * @return a {@code Flowable} that emits those items emitted by the current {@code Flowable} that have distinct keys + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: Distinct * @see #distinct(Function, Supplier) @@ -9122,7 +9022,7 @@ public final Flowable distinct(@NonNull Function keySelecto * @param collectionSupplier * function called for each individual {@link Subscriber} to return a {@link Collection} subtype for holding the extracted * keys and whose add() method's return indicates uniqueness. - * @return a {@code Flowable} that emits those items emitted by the current {@code Flowable} that have distinct keys + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} or {@code collectionSupplier} is {@code null} * @see ReactiveX operators documentation: Distinct */ @@ -9166,8 +9066,7 @@ public final Flowable distinct(@NonNull Function keySelecto *
{@code distinctUntilChanged} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits those items from the current {@code Flowable} that are distinct from their - * immediate predecessors + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Distinct * @see #distinctUntilChanged(BiPredicate) */ @@ -9214,8 +9113,7 @@ public final Flowable distinctUntilChanged() { * @param keySelector * a function that projects an emitted item to a key value that is used to decide whether an item * is distinct from another one or not - * @return a {@code Flowable} that emits those items from the current {@code Flowable} whose keys are distinct from - * those of their immediate predecessors + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: Distinct */ @@ -9253,8 +9151,7 @@ public final Flowable distinctUntilChanged(@NonNull FunctionReactiveX operators documentation: Distinct * @since 2.0 @@ -9344,8 +9241,7 @@ public final Flowable doAfterNext(@NonNull Consumer onAfterNext) { * * @param onAfterTerminate * an {@code Action} to be invoked when the current {@code Flowable} finishes - * @return a {@code Flowable} that emits the same items as the current {@code Flowable}, then invokes the - * {@code Action} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onAfterTerminate} is {@code null} * @see ReactiveX operators documentation: Do * @see #doOnTerminate(Action) @@ -9379,7 +9275,7 @@ public final Flowable doAfterTerminate(@NonNull Action onAfterTerminate) { * * @param onCancel * the action that gets called when the current {@code Flowable}'s {@link Subscription} is canceled - * @return the current {@code Flowable} modified so as to call this {@code Action} when appropriate + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onCancel} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9405,7 +9301,7 @@ public final Flowable doOnCancel(@NonNull Action onCancel) { * * @param onComplete * the action to invoke when the current {@code Flowable} calls {@code onComplete} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onComplete} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9431,7 +9327,7 @@ public final Flowable doOnComplete(@NonNull Action onComplete) { *
{@code doOnEach} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onNext}, {@code onError}, {@code onComplete} or {@code onAfterTerminate} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9463,7 +9359,7 @@ private Flowable doOnEach(@NonNull Consumer onNext, @NonNull Consu * * @param onNotification * the action to invoke for each item emitted by the current {@code Flowable} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onNotification} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9502,7 +9398,7 @@ public final Flowable doOnEach(@NonNull Consumer<@NonNull ? super Notificatio * @param subscriber * the {@code Subscriber} to be notified about {@code onNext}, {@code onError} and {@code onComplete} events on its * respective methods before the actual downstream {@code Subscriber} gets notified. - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code subscriber} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9537,7 +9433,7 @@ public final Flowable doOnEach(@NonNull Subscriber<@NonNull ? super T> subscr * * @param onError * the action to invoke if the current {@code Flowable} calls {@code onError} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onError} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9569,7 +9465,7 @@ public final Flowable doOnError(@NonNull Consumer onError) * a {@link LongConsumer} called with the request amount sent via {@link Subscription#request(long)} * @param onCancel * called when the downstream cancels the {@code Subscription} via {@link Subscription#cancel()} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onSubscribe}, {@code onRequest} or {@code onCancel} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9599,7 +9495,7 @@ public final Flowable doOnLifecycle(@NonNull Consumer o * * @param onNext * the action to invoke when the current {@code Flowable} calls {@code onNext} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onNext} is {@code null} * @see ReactiveX operators documentation: Do * @see #doAfterNext(Consumer) @@ -9630,7 +9526,7 @@ public final Flowable doOnNext(@NonNull Consumer onNext) { * @param onRequest * the action that gets called when a {@link Subscriber} requests items from the current * {@code Flowable} - * @return the current {@code Flowable} modified so as to call this {@link Action} when appropriate + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onRequest} is {@code null} * @see ReactiveX operators * documentation: Do @@ -9660,7 +9556,7 @@ public final Flowable doOnRequest(@NonNull LongConsumer onRequest) { * * @param onSubscribe * the {@code Consumer} that gets called when a {@link Subscriber} subscribes to the current {@code Flowable} - * @return the current {@code Flowable} modified so as to call this {@code Consumer} when appropriate + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onSubscribe} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -9690,7 +9586,7 @@ public final Flowable doOnSubscribe(@NonNull Consumer o * * @param onTerminate * the action to invoke when the current {@code Flowable} calls {@code onComplete} or {@code onError} - * @return the current {@code Flowable} with the side-effecting behavior applied + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onTerminate} is {@code null} * @see ReactiveX operators documentation: Do * @see #doAfterTerminate(Action) @@ -9718,8 +9614,7 @@ public final Flowable doOnTerminate(@NonNull Action onTerminate) { * * @param index * the zero-based index of the item to retrieve - * @return a {@code Maybe} that emits a single item: the item at the specified position in the sequence of - * those emitted by the current {@code Flowable} + * @return the new {@code Maybe} instance * @throws IndexOutOfBoundsException if {@code index} is negative * @see ReactiveX operators documentation: ElementAt */ @@ -9750,8 +9645,7 @@ public final Maybe elementAt(long index) { * the zero-based index of the item to retrieve * @param defaultItem * the default item - * @return a {@code Single} that emits the item at the specified position in the sequence emitted by the current - * {@code Flowable}, or the default item if that index is outside the bounds of the source sequence + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @throws IndexOutOfBoundsException * if {@code index} is negative @@ -9783,8 +9677,7 @@ public final Single elementAt(long index, @NonNull T defaultItem) { * * @param index * the zero-based index of the item to retrieve - * @return a {@code Single} that emits the item at the specified position in the sequence emitted by the current - * {@code Flowable}, or the default item if that index is outside the bounds of the source sequence + * @return the new {@code Single} instance * @throws IndexOutOfBoundsException * if {@code index} is less than 0 * @see ReactiveX operators documentation: ElementAt @@ -9815,8 +9708,7 @@ public final Single elementAtOrError(long index) { * @param predicate * a function that evaluates each item emitted by the current {@code Flowable}, returning {@code true} * if it passes the filter - * @return a {@code Flowable} that emits only those items emitted by the current {@code Flowable} that the filter - * evaluates as {@code true} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: Filter */ @@ -9866,8 +9758,7 @@ public final Maybe firstElement() { * * @param defaultItem * the default item to emit if the current {@code Flowable} doesn't emit anything - * @return a {@code Single} that emits only the very first item from the source, or a default item if the - * current {@code Flowable} completes without emitting any items + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: First */ @@ -9922,9 +9813,7 @@ public final Single firstOrError() { * @param mapper * a function that, when applied to an item emitted by the current {@code Flowable}, returns a * {@code Publisher} - * @return a {@code Flowable} that emits the result of applying the transformation function to each item emitted - * by the current {@code Flowable} and merging the results of the {@code Publisher}s obtained from this - * transformation + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap */ @@ -9959,9 +9848,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -9996,9 +9883,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -10038,9 +9923,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap * @since 2.0 @@ -10081,9 +9964,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -10134,8 +10015,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -10181,8 +10061,7 @@ public final Flowable flatMap( * {@code Flowable} * @param maxConcurrency * the maximum number of {@code Publisher}s that may be subscribed to concurrently - * @return a {@code Flowable} that emits the results of merging the {@code Publisher}s returned from applying the - * specified functions to the emissions and notifications of the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onNextMapper}, {@code onErrorMapper} or {@code onCompleteSupplier} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: FlatMap @@ -10228,8 +10107,7 @@ public final Flowable flatMap( * @param combiner * a function that combines one item emitted by each of the source and collection {@code Publisher}s and * returns an item to be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that emits the results of applying a function to a pair of values emitted by the - * current {@code Flowable} and the collection {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code mapper} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: FlatMap */ @@ -10269,8 +10147,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -10313,8 +10190,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -10361,8 +10237,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -10408,8 +10283,7 @@ public final Flowable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -10566,8 +10440,7 @@ public final Flowable flatMapIterable(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -10903,9 +10776,7 @@ public final Disposable forEachWhile(@NonNull Predicate onNext, @NonN * a function that extracts the key for each item * @param * the key type - * @return a {@code Flowable} that emits {@code GroupedFlowable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Flowable} that share that - * key value + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: GroupBy * @see #groupBy(Function, boolean) @@ -10966,9 +10837,7 @@ public final Flowable> groupBy(@NonNull FunctionReactiveX operators documentation: GroupBy */ @@ -11028,9 +10897,7 @@ public final Flowable> groupBy(@NonNull Function * the element type - * @return a {@code Flowable} that emits {@code GroupedFlowable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Flowable} that share that - * key value + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @see ReactiveX operators documentation: GroupBy * @see #groupBy(Function, Function, boolean) @@ -11097,9 +10964,7 @@ public final Flowable> groupBy(@NonNull FunctionReactiveX operators documentation: GroupBy * @see #groupBy(Function, Function, boolean, int) @@ -11166,9 +11031,7 @@ public final Flowable> groupBy(@NonNull Function * the element type - * @return a {@code Flowable} that emits {@code GroupedFlowable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Flowable} that share that - * key value + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: GroupBy @@ -11287,9 +11150,7 @@ public final Flowable> groupBy(@NonNull Function * the element type - * @return a {@code Flowable} that emits {@code GroupedFlowable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Flowable} that share that - * key value + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code keySelector}, {@code valueSelector} or {@code evictingMapFactory} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: GroupBy @@ -11342,8 +11203,7 @@ public final Flowable> groupBy(@NonNull FunctionReactiveX operators documentation: Join */ @@ -11400,8 +11260,7 @@ public final Flowable hide() { *
{@code ignoreElements} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@link Completable} that only calls {@code onComplete} or {@code onError}, based on which one is - * called by the current {@code Flowable} + * @return the new {@link Completable} instance * @see ReactiveX operators documentation: IgnoreElements */ @CheckReturnValue @@ -11427,7 +11286,7 @@ public final Completable ignoreElements() { *
{@code isEmpty} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a {@link Boolean} + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Contains */ @CheckReturnValue @@ -11468,8 +11327,7 @@ public final Single isEmpty() { * @param resultSelector * a function that computes an item to be emitted by the resulting {@code Flowable} for any two * overlapping items emitted by the two {@code Publisher}s - * @return a {@code Flowable} that emits items correlating to items emitted by the current {@code Flowable}s that have - * overlapping durations + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other}, {@code leftEnd}, {@code rightEnd} or {@code resultSelector} is {@code null} * @see ReactiveX operators documentation: Join */ @@ -11503,7 +11361,7 @@ public final Flowable join( *
{@code lastElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return a new {@code Maybe} instance + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: Last */ @CheckReturnValue @@ -11738,8 +11596,7 @@ public final Flowable lift(@NonNull FlowableOperator the output type * @param mapper * a function to apply to each item emitted by the current {@code Flowable} - * @return a {@code Flowable} that emits the items from the current {@code Flowable}, transformed by the specified - * function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: Map * @see #mapOptional(Function) @@ -11766,8 +11623,7 @@ public final Flowable lift(@NonNull FlowableOperator{@code materialize} does not operate by default on a particular {@link Scheduler}. * * - * @return a {@code Flowable} that emits items that are the result of materializing the items and notifications - * of the current {@code Flowable} + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Materialize * @see #dematerialize(Function) */ @@ -11796,7 +11652,7 @@ public final Flowable> materialize() { * * @param other * a {@code Publisher} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the current {@code Flowable}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -11929,8 +11785,7 @@ public final Flowable mergeWith(@NonNull CompletableSource other) { * * @param scheduler * the {@code Scheduler} to notify {@link Subscriber}s on - * @return the current {@code Flowable} modified so that its {@code Subscriber}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: ObserveOn * @see RxJava Threading Examples @@ -11982,8 +11837,7 @@ public final Flowable observeOn(@NonNull Scheduler scheduler) { * indicates if the {@code onError} notification may not cut ahead of {@code onNext} notification on the other side of the * scheduling boundary. If {@code true}, a sequence ending in {@code onError} will be replayed in the same order as was received * from upstream - * @return the current {@code Flowable} modified so that its {@code Subscriber}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: ObserveOn * @see RxJava Threading Examples @@ -12036,8 +11890,7 @@ public final Flowable observeOn(@NonNull Scheduler scheduler, boolean delayEr * scheduling boundary. If {@code true}, a sequence ending in {@code onError} will be replayed in the same order as was received * from upstream * @param bufferSize the size of the buffer. - * @return the current {@code Flowable} modified so that its {@code Subscriber}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: ObserveOn @@ -12072,7 +11925,7 @@ public final Flowable observeOn(@NonNull Scheduler scheduler, boolean delayEr * @param the output type * @param clazz * the class type to filter the items emitted by the current {@code Flowable} - * @return a {@code Flowable} that emits items from the current {@code Flowable} of type {@code clazz} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code clazz} is {@code null} * @see ReactiveX operators documentation: Filter */ @@ -12101,7 +11954,7 @@ public final Flowable ofType(@NonNull Class clazz) { *
{@code onBackpressureBuffer} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Flowable} modified to buffer items to the extent system resources allow + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: backpressure operators * #see {@link #onBackpressureBuffer(boolean)} */ @@ -12129,7 +11982,7 @@ public final Flowable onBackpressureBuffer() { * if {@code true}, an exception from the current {@code Flowable} is delayed until all buffered elements have been * consumed by the downstream; if {@code false}, an exception is immediately signaled to the downstream, skipping * any buffered element - * @return the current {@code Flowable} modified to buffer items to the extent system resources allow + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: backpressure operators */ @CheckReturnValue @@ -12159,7 +12012,7 @@ public final Flowable onBackpressureBuffer(boolean delayError) { * * * @param capacity number of slots available in the buffer. - * @return the current {@code Flowable} modified to buffer items up to the given capacity. + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators * @since 1.1.0 @@ -12193,7 +12046,7 @@ public final Flowable onBackpressureBuffer(int capacity) { * if {@code true}, an exception from the current {@code Flowable} is delayed until all buffered elements have been * consumed by the downstream; if {@code false}, an exception is immediately signaled to the downstream, skipping * any buffered element - * @return the current {@code Flowable} modified to buffer items up to the given capacity. + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators * @since 1.1.0 @@ -12229,7 +12082,7 @@ public final Flowable onBackpressureBuffer(int capacity, boolean delayError) * any buffered element * @param unbounded * if {@code true}, the capacity value is interpreted as the internal "island" size of the unbounded buffer - * @return the current {@code Flowable} modified to buffer items up to the given capacity. + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators * @since 1.1.0 @@ -12267,7 +12120,7 @@ public final Flowable onBackpressureBuffer(int capacity, boolean delayError, * @param unbounded * if {@code true}, the capacity value is interpreted as the internal "island" size of the unbounded buffer * @param onOverflow action to execute if an item needs to be buffered, but there are no available slots. - * @return the current {@code Flowable} modified to buffer items up to the given capacity + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onOverflow} is {@code null} * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators @@ -12301,7 +12154,7 @@ public final Flowable onBackpressureBuffer(int capacity, boolean delayError, * * @param capacity number of slots available in the buffer. * @param onOverflow action to execute if an item needs to be buffered, but there are no available slots. Null is allowed. - * @return the current {@code Flowable} modified to buffer items up to the given capacity + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onOverflow} is {@code null} * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators @@ -12343,7 +12196,7 @@ public final Flowable onBackpressureBuffer(int capacity, @NonNull Action onOv * @param capacity number of slots available in the buffer. * @param onOverflow action to execute if an item needs to be buffered, but there are no available slots, {@code null} is allowed. * @param overflowStrategy how should the resulting {@code Flowable} react to buffer overflows, {@code null} is not allowed. - * @return the source {@code Flowable} modified to buffer items up to the given capacity + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onOverflow} or {@code overflowStrategy} is {@code null} * @throws IllegalArgumentException if {@code capacity} is non-positive * @see ReactiveX operators documentation: backpressure operators @@ -12375,7 +12228,7 @@ public final Flowable onBackpressureBuffer(long capacity, @Nullable Action on *
{@code onBackpressureDrop} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Flowable} modified to drop {@code onNext} notifications on overflow + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: backpressure operators */ @CheckReturnValue @@ -12404,7 +12257,7 @@ public final Flowable onBackpressureDrop() { * * * @param onDrop the action to invoke for each item dropped, should be fast and should never block. - * @return the current {@code Flowable} modified to drop {@code onNext} notifications on overflow + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code onDrop} is {@code null} * @see ReactiveX operators documentation: backpressure operators * @since 1.1.0 @@ -12441,7 +12294,7 @@ public final Flowable onBackpressureDrop(@NonNull Consumer onDrop) *
{@code onBackpressureLatest} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Flowable} modified so that it emits the most recently-received item upon request + * @return the new {@code Flowable} instance * @since 1.1.0 */ @CheckReturnValue @@ -12484,7 +12337,7 @@ public final Flowable onBackpressureLatest() { * @param resumeFunction * a function that returns a {@code Publisher} that will take over if the current {@code Flowable} encounters * an error - * @return the original {@code Publisher}, with appropriately modified behavior + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code resumeFunction} is {@code null} * @see ReactiveX operators documentation: Catch */ @@ -12529,7 +12382,7 @@ public final Flowable onErrorResumeNext(@NonNull FunctionReactiveX operators documentation: Catch */ @@ -12570,7 +12423,7 @@ public final Flowable onErrorResumeWith(@NonNull Publisher<@NonNull ? extends * @param valueSupplier * a function that returns a single value that will be emitted along with a regular {@code onComplete} in case * the current {@code Flowable} signals an {@code onError} event - * @return the original {@code Publisher} with appropriately modified behavior + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code valueSupplier} is {@code null} * @see ReactiveX operators documentation: Catch */ @@ -12610,7 +12463,7 @@ public final Flowable onErrorReturn(@NonNull FunctionReactiveX operators documentation: Catch */ @@ -12633,7 +12486,7 @@ public final Flowable onErrorReturnItem(@NonNull T item) { *
Scheduler:
*
{@code onTerminateDetach} does not operate by default on a particular {@link Scheduler}.
* - * @return a {@code Flowable} which {@code null}s out references to the upstream producer and downstream {@code Subscriber} if + * @return the new {@code Flowable} instance * the sequence is terminated or downstream cancels * @since 2.0 */ @@ -12756,8 +12609,7 @@ public final ParallelFlowable parallel(int parallelism, int prefetch) { *
{@code publish} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code ConnectableFlowable} that upon connection causes the current {@code Flowable} to emit items - * to its {@code Subscriber}s + * @return the new {@code ConnectableFlowable} instance * @see ReactiveX operators documentation: Publish */ @CheckReturnValue @@ -12790,7 +12642,7 @@ public final ConnectableFlowable publish() { * a function that can use the multicasted source sequence as many times as needed, without * causing multiple subscriptions to the source sequence. {@link Subscriber}s to the given source will * receive all notifications of the source from the time of the subscription forward. - * @return a {@code Flowable} that emits the results of invoking the selector on the items emitted by a {@code ConnectableFlowable} that shares a single subscription to the underlying sequence + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Publish */ @@ -12826,7 +12678,7 @@ public final Flowable publish(@NonNull Function, ? ex * receive all notifications of the source from the time of the subscription forward. * @param prefetch * the number of elements to prefetch from the current {@code Flowable} - * @return a {@code Flowable} that emits the results of invoking the selector on the items emitted by a {@code ConnectableFlowable} that shares a single subscription to the underlying sequence + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @throws IllegalArgumentException if {@code prefetch} is non-positive * @see ReactiveX operators documentation: Publish @@ -12858,8 +12710,7 @@ public final Flowable publish(@NonNull Function, ? ex * * @param bufferSize * the number of elements to prefetch from the current {@code Flowable} - * @return a {@code ConnectableFlowable} that upon connection causes the current {@code Flowable} to emit items - * to its {@code Subscriber}s + * @return the new {@code ConnectableFlowable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Publish */ @@ -12887,7 +12738,7 @@ public final ConnectableFlowable publish(int bufferSize) { * * * @param n the initial request amount, further request will happen after 75% of this value - * @return the {@code Flowable} that rebatches request amounts from downstream + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code n} is non-positive * @since 2.0 */ @@ -12925,8 +12776,7 @@ public final Flowable rebatchRequests(int n) { * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, whose * result will be used in the next accumulator call - * @return a {@code Maybe} that emits a single item that is the result of accumulating the items emitted by - * the source {@code Flowable} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -12987,8 +12837,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, the * result of which will be used in the next accumulator call - * @return a {@code Single} that emits a single item that is the result of accumulating the output from the - * items emitted by the current {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code seed} or {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -13034,8 +12883,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, the * result of which will be used in the next accumulator call - * @return a {@code Single} that emits a single item that is the result of accumulating the output from the - * items emitted by the current {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code seedSupplier} or {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -13062,7 +12910,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { *
{@code repeat} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} repeatedly and in sequence + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Repeat */ @CheckReturnValue @@ -13089,8 +12937,7 @@ public final Flowable repeat() { * @param times * the number of times the current {@code Flowable} items are repeated, a count of 0 will yield an empty * sequence - * @return a {@code Flowable} that repeats the sequence of items emitted by the current {@code Flowable} at most - * {@code count} times + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code times} is less than zero * @see ReactiveX operators documentation: Repeat @@ -13158,7 +13005,7 @@ public final Flowable repeatUntil(@NonNull BooleanSupplier stop) { * * @param handler * receives a {@code Publisher} of notifications with which a user can complete or error, aborting the repeat. - * @return the current {@code Flowable} modified with repeat logic + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code handler} is {@code null} * @see ReactiveX operators documentation: Repeat */ @@ -13187,8 +13034,7 @@ public final Flowable repeatWhen(@NonNull Function, *
This version of {@code replay} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code ConnectableFlowable} that upon connection causes the current {@code Flowable} to emit its - * items to its {@code Subscriber}s + * @return the new {@code ConnectableFlowable} instance * @see ReactiveX operators documentation: Replay */ @CheckReturnValue @@ -13218,8 +13064,7 @@ public final ConnectableFlowable replay() { * @param selector * the selector function, which can use the multicasted sequence as many times as needed, without * causing multiple subscriptions to the current {@code Flowable} - * @return a {@code Flowable} that emits items that are the results of invoking the selector on a - * {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -13257,9 +13102,7 @@ public final Flowable replay(@NonNull Function, ? ext * causing multiple subscriptions to the current {@code Flowable} * @param bufferSize * the buffer size that limits the number of items the operator can replay - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} - * replaying no more than {@code bufferSize} items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13303,9 +13146,7 @@ public final Flowable replay(@NonNull Function, ? ext * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} - * replaying no more than {@code bufferSize} items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13349,10 +13190,7 @@ public final Flowable replay(@NonNull Function, ? ext * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} or {@code unit} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13396,10 +13234,7 @@ public final Flowable replay(@NonNull Function, ? ext * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that is the time source for the window - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code bufferSize} is non-positive @@ -13453,10 +13288,7 @@ public final Flowable replay(@NonNull Function, ? ext * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code bufferSize} is less than zero @@ -13499,9 +13331,7 @@ public final Flowable replay(@NonNull Function, ? ext * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector} or {@code unit} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -13539,9 +13369,7 @@ public final Flowable replay(@NonNull Function, ? ext * the time unit of {@code time} * @param scheduler * the scheduler that is the time source for the window - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay * @see #replay(Function, long, TimeUnit, Scheduler, boolean) @@ -13586,9 +13414,7 @@ public final Flowable replay(@NonNull Function, ? ext * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code Flowable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -13626,8 +13452,7 @@ public final Flowable replay(@NonNull Function, ? ext * * @param bufferSize * the buffer size that limits the number of items that can be replayed - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays at most {@code bufferSize} items emitted by the current {@code Flowable} + * @return the new {@code ConnectableFlowable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay * @see #replay(int, boolean) @@ -13665,8 +13490,7 @@ public final ConnectableFlowable replay(int bufferSize) { * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays at most {@code bufferSize} items emitted by the current {@code Flowable} + * @return the new {@code ConnectableFlowable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay * @since 3.0.0 @@ -13707,9 +13531,7 @@ public final ConnectableFlowable replay(int bufferSize, boolean eagerTruncate * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13752,9 +13574,7 @@ public final ConnectableFlowable replay(int bufferSize, long time, @NonNull T * the time unit of {@code time} * @param scheduler * the scheduler that is used as a time source for the window - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13802,9 +13622,7 @@ public final ConnectableFlowable replay(int bufferSize, long time, @NonNull T * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -13844,8 +13662,7 @@ public final ConnectableFlowable replay(int bufferSize, long time, @NonNull T * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -13882,8 +13699,7 @@ public final ConnectableFlowable replay(long time, @NonNull TimeUnit unit) { * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that is the time source for the window - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay * @see #replay(long, TimeUnit, Scheduler, boolean) @@ -13926,8 +13742,7 @@ public final ConnectableFlowable replay(long time, @NonNull TimeUnit unit, @N * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code ConnectableFlowable} that shares a single subscription to the current {@code Flowable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableFlowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -13962,7 +13777,7 @@ public final ConnectableFlowable replay(long time, @NonNull TimeUnit unit, @N *
{@code retry} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Flowable} modified with retry logic + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Retry */ @CheckReturnValue @@ -13989,7 +13804,7 @@ public final Flowable retry() { * @param predicate * the predicate that determines if a resubscription may happen in case of a specific exception * and retry count - * @return the current {@code Flowable} modified with retry logic + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see #retry() * @see ReactiveX operators documentation: Retry @@ -14028,7 +13843,7 @@ public final Flowable retry(@NonNull BiPredicate<@NonNull ? super Integer, @N * * @param times * the number of times to resubscribe if the current {@code Flowable} fails - * @return the current {@code Flowable} modified with retry logic + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code times} is negative * @see ReactiveX operators documentation: Retry */ @@ -14187,7 +14002,7 @@ public final Flowable retryUntil(@NonNull BooleanSupplier stop) { * @param handler * receives a {@code Publisher} of notifications with which a user can complete or error, aborting the * retry - * @return the current {@code Flowable} modified with retry logic + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code handler} is {@code null} * @see ReactiveX operators documentation: Retry */ @@ -14243,8 +14058,7 @@ public final void safeSubscribe(@NonNull Subscriber<@NonNull ? super T> subscrib * the sampling rate * @param unit * the {@link TimeUnit} in which {@code period} is defined - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} at - * the specified time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14279,8 +14093,7 @@ public final Flowable sample(long period, @NonNull TimeUnit unit) { * if {@code true}, and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} at - * the specified time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14313,8 +14126,7 @@ public final Flowable sample(long period, @NonNull TimeUnit unit, boolean emi * the {@link TimeUnit} in which {@code period} is defined * @param scheduler * the {@code Scheduler} to use when sampling - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} at - * the specified time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14354,8 +14166,7 @@ public final Flowable sample(long period, @NonNull TimeUnit unit, @NonNull Sc * if {@code true} and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} at - * the specified time interval + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14389,8 +14200,7 @@ public final Flowable sample(long period, @NonNull TimeUnit unit, @NonNull Sc * @param the element type of the sampler {@code Publisher} * @param sampler * the {@code Publisher} to use for sampling the current {@code Flowable} - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} whenever - * the {@code sampler} {@code Publisher} emits an item or completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sampler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14427,8 +14237,7 @@ public final Flowable sample(@NonNull Publisher sampler) { * if {@code true} and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. - * @return a {@code Flowable} that emits the results of sampling the items emitted by the current {@code Flowable} whenever - * the {@code sampler} {@code Publisher} emits an item or completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sampler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -14464,7 +14273,7 @@ public final Flowable sample(@NonNull Publisher sampler, boolean emitL * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, whose * result will be emitted to {@link Subscriber}s via {@link Subscriber#onNext onNext} and used in the * next accumulator call - * @return a {@code Flowable} that emits the results of each call to the accumulator function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -14518,8 +14327,7 @@ public final Flowable scan(@NonNull BiFunction accumulator) { * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, whose * result will be emitted to {@link Subscriber}s via {@link Subscriber#onNext onNext} and used in the * next accumulator call - * @return a {@code Flowable} that emits {@code initialValue} followed by the results of each call to the - * accumulator function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code initialValue} or {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -14559,8 +14367,7 @@ public final Flowable scan(@NonNull BiFunction accumulator) { * an accumulator function to be invoked on each item emitted by the current {@code Flowable}, whose * result will be emitted to {@code Subscriber}s via {@link Subscriber#onNext onNext} and used in the * next accumulator call - * @return a {@code Flowable} that emits {@code initialValue} followed by the results of each call to the - * accumulator function + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code seedSupplier} or {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -14593,8 +14400,7 @@ public final Flowable scan(@NonNull BiFunction accumulator) { *
{@code serialize} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that is guaranteed to be well-behaved and to make only serialized calls to - * its {@code Subscriber}s + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Serialize */ @CheckReturnValue @@ -14622,8 +14428,7 @@ public final Flowable serialize() { *
{@code share} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that upon connection causes the current {@code Flowable} to emit items - * to its {@code Subscriber}s + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: RefCount */ @CheckReturnValue @@ -14648,7 +14453,7 @@ public final Flowable share() { *
{@code singleElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Maybe} that emits the single item emitted by the current {@code Flowable} + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: First */ @CheckReturnValue @@ -14675,8 +14480,7 @@ public final Maybe singleElement() { * * @param defaultItem * a default value to emit if the current {@code Flowable} emits no item - * @return a {@code Single} that emits the single item emitted by the current {@code Flowable}, or a default item if - * the current {@code Flowable} is empty + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: First */ @@ -14730,8 +14534,7 @@ public final Single singleOrError() { * * @param count * the number of items to skip - * @return a {@code Flowable} that is identical to the current {@code Flowable} except that it does not emit the first - * {@code count} items that the current {@code Flowable} emits + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count} is negative * @see ReactiveX operators documentation: Skip */ @@ -14767,8 +14570,7 @@ public final Flowable skip(long count) { * the length of the time window to skip * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that skips values emitted by the current {@code Flowable} before the time window defined - * by {@code time} elapses and the emits the remainder + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Skip */ @@ -14799,8 +14601,7 @@ public final Flowable skip(long time, @NonNull TimeUnit unit) { * the time unit of {@code time} * @param scheduler * the {@code Scheduler} on which the timed wait happens - * @return a {@code Flowable} that skips values emitted by the current {@code Flowable} before the time window defined - * by {@code time} and {@code scheduler} elapses, and then emits the remainder + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Skip */ @@ -14831,8 +14632,7 @@ public final Flowable skip(long time, @NonNull TimeUnit unit, @NonNull Schedu * * @param count * number of items to drop from the end of the source sequence - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} except for the dropped ones - * at the end + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code count} is less than zero * @see ReactiveX operators documentation: SkipLast @@ -14871,8 +14671,7 @@ public final Flowable skipLast(int count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that drops those items emitted by the current {@code Flowable} in a time window before the - * source completes defined by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -14907,8 +14706,7 @@ public final Flowable skipLast(long time, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, an exception signaled by the current {@code Flowable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return a {@code Flowable} that drops those items emitted by the current {@code Flowable} in a time window before the - * source completes defined by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -14941,8 +14739,7 @@ public final Flowable skipLast(long time, @NonNull TimeUnit unit, boolean del * the time unit of {@code time} * @param scheduler * the scheduler used as the time source - * @return a {@code Flowable} that drops those items emitted by the current {@code Flowable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -14978,8 +14775,7 @@ public final Flowable skipLast(long time, @NonNull TimeUnit unit, @NonNull Sc * @param delayError * if {@code true}, an exception signaled by the current {@code Flowable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return a {@code Flowable} that drops those items emitted by the current {@code Flowable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -15017,8 +14813,7 @@ public final Flowable skipLast(long time, @NonNull TimeUnit unit, @NonNull Sc * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be skipped - * @return a {@code Flowable} that drops those items emitted by the current {@code Flowable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SkipLast @@ -15053,8 +14848,7 @@ public final Flowable skipLast(long time, @NonNull TimeUnit unit, @NonNull Sc * @param other * the second {@code Publisher} that has to emit an item before the current {@code Flowable}'s elements begin * to be mirrored by the resulting {@code Flowable} - * @return a {@code Flowable} that skips items from the current {@code Flowable} until the second {@code Publisher} emits an - * item, then emits the remaining items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: SkipUntil */ @@ -15082,8 +14876,7 @@ public final Flowable skipUntil(@NonNull Publisher other) { * * @param predicate * a function to test each item emitted from the current {@code Flowable} - * @return a {@code Flowable} that begins emitting items emitted by the current {@code Flowable} when the specified - * predicate becomes {@code false} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: SkipWhile */ @@ -15114,7 +14907,7 @@ public final Flowable skipWhile(@NonNull Predicate predicate) { *
{@code sorted} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} in sorted order + * @return the new {@code Flowable} instance */ @CheckReturnValue @BackpressureSupport(BackpressureKind.FULL) @@ -15143,7 +14936,7 @@ public final Flowable sorted() { * a function that compares two items emitted by the current {@code Flowable} and returns an {@link Integer} * that indicates their sort order * @throws NullPointerException if {@code comparator} is {@code null} - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} in sorted order + * @return the new {@code Flowable} instance */ @CheckReturnValue @NonNull @@ -15170,8 +14963,7 @@ public final Flowable sorted(@NonNull Comparator<@NonNull ? super T> comparat * * @param items * an {@code Iterable} that contains the items you want the resulting {@code Flowable} to emit first - * @return a {@code Flowable} that emits the items in the specified {@code Iterable} and then emits the items - * emitted by the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: StartWith * @see #startWithArray(Object...) @@ -15202,8 +14994,7 @@ public final Flowable startWithIterable(@NonNull Iterable<@NonNull ? extends * * @param other * a {@code Publisher} that contains the items you want the modified {@code Publisher} to emit first - * @return a {@code Flowable} that emits the items in the specified {@code Publisher} and then emits the items - * emitted by the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: StartWith */ @@ -15232,8 +15023,7 @@ public final Flowable startWith(@NonNull Publisher<@NonNull ? extends T> othe * * @param item * the item to emit first - * @return a {@code Flowable} that emits the specified item before it begins to emit items emitted by the current - * {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: StartWith * @see #startWithArray(Object...) @@ -15265,8 +15055,7 @@ public final Flowable startWithItem(@NonNull T item) { * * @param items * the array of values to emit first - * @return a {@code Flowable} that emits the specified items before it begins to emit items emitted by the current - * {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: StartWith * @see #startWithItem(Object) @@ -15299,8 +15088,7 @@ public final Flowable startWithArray(@NonNull T... items) { *
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Flowable} has finished sending them + * @return the new {@link Disposable} instance that allows cancelling the flow * @see ReactiveX operators documentation: Subscribe */ @BackpressureSupport(BackpressureKind.UNBOUNDED_IN) @@ -15326,8 +15114,7 @@ public final Disposable subscribe() { * * @param onNext * the {@code Consumer} you have designed to accept emissions from the current {@code Flowable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Flowable} has finished sending them + * @return the new {@link Disposable} instance that allows cancelling the flow * @throws NullPointerException * if {@code onNext} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -15356,8 +15143,7 @@ public final Disposable subscribe(@NonNull Consumer onNext) { * @param onError * the {@code Consumer} you have designed to accept any error notification from the * current {@code Flowable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Flowable} has finished sending them + * @return the new {@link Disposable} instance that allows cancelling the flow * @see ReactiveX operators documentation: Subscribe * @throws NullPointerException * if {@code onNext} or {@code onError} is {@code null} @@ -15389,8 +15175,7 @@ public final Disposable subscribe(@NonNull Consumer onNext, @NonNull * @param onComplete * the {@link Action} you have designed to accept a completion notification from the * the current {@code Flowable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Flowable} has finished sending them + * @return the new {@link Disposable} instance that allows cancelling the flow * @throws NullPointerException * if {@code onNext}, {@code onError} or {@code onComplete} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -15550,8 +15335,7 @@ public final void subscribe(@NonNull FlowableSubscriber<@NonNull ? super T> subs * * @param scheduler * the {@code Scheduler} to perform subscription actions on - * @return the current {@code Flowable} modified so that its subscriptions happen on the - * specified {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SubscribeOn * @see RxJava Threading Examples @@ -15589,8 +15373,7 @@ public final Flowable subscribeOn(@NonNull Scheduler scheduler) { * @param requestOn if {@code true}, requests are rerouted to the given {@code Scheduler} as well (strong pipelining) * if {@code false}, requests coming from any thread are simply forwarded to * the upstream on the same thread (weak pipelining) - * @return the current {@code Flowable} modified so that its subscriptions happen on the - * specified {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SubscribeOn * @see RxJava Threading Examples @@ -15624,8 +15407,7 @@ public final Flowable subscribeOn(@NonNull Scheduler scheduler, boolean reque * * @param other * the alternate {@code Publisher} to subscribe to if the source does not emit any items - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} or the items of an - * alternate {@code Publisher} if the current {@code Flowable} is empty. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @since 1.1.0 */ @@ -15661,7 +15443,7 @@ public final Flowable switchIfEmpty(@NonNull Publisher<@NonNull ? extends T> * @param mapper * a function that, when applied to an item emitted by the current {@code Flowable}, returns a * {@code Publisher} - * @return a {@code Flowable} that emits the items emitted by the {@code Publisher} returned from applying {@code func} to the most recently emitted item emitted by the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap * @see #switchMapDelayError(Function) @@ -15699,7 +15481,7 @@ public final Flowable switchMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -15832,7 +15614,7 @@ public final Completable switchMapCompletableDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap * @see #switchMap(Function) @@ -15872,7 +15654,7 @@ public final Flowable switchMapDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -16085,8 +15867,7 @@ public final Flowable switchMapSingleDelayError(@NonNull FunctionReactiveX operators documentation: Take */ @@ -16121,7 +15902,7 @@ public final Flowable take(long count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that emits those items emitted by the current {@code Flowable} before the time runs out + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Take */ @@ -16155,8 +15936,7 @@ public final Flowable take(long time, @NonNull TimeUnit unit) { * the time unit of {@code time} * @param scheduler * the {@code Scheduler} used for time source - * @return a {@code Flowable} that emits those items emitted by the current {@code Flowable} before the time runs out, - * according to the specified {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Take */ @@ -16184,7 +15964,7 @@ public final Flowable take(long time, @NonNull TimeUnit unit, @NonNull Schedu * @param count * the maximum number of items to emit from the end of the sequence of items emitted by the current * {@code Flowable} - * @return a {@code Flowable} that emits at most the last {@code count} items emitted by the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code count} is negative * @see ReactiveX operators documentation: TakeLast @@ -16226,8 +16006,7 @@ public final Flowable takeLast(int count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that emits at most {@code count} items from the current {@code Flowable} that were emitted - * in a specified window of time before the current {@code Flowable} completed + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is negative * @see ReactiveX operators documentation: TakeLast @@ -16262,9 +16041,7 @@ public final Flowable takeLast(long count, long time, @NonNull TimeUnit unit) * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that provides the timestamps for the observed items - * @return a {@code Flowable} that emits at most {@code count} items from the current {@code Flowable} that were emitted - * in a specified window of time before the current {@code Flowable} completed, where the timing information is - * provided by the given {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code count} is less than zero @@ -16305,9 +16082,7 @@ public final Flowable takeLast(long count, long time, @NonNull TimeUnit unit, * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be last - * @return a {@code Flowable} that emits at most {@code count} items from the current {@code Flowable} that were emitted - * in a specified window of time before the current {@code Flowable} completed, where the timing information is - * provided by the given {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code count} is negative or {@code bufferSize} is non-positive @@ -16346,8 +16121,7 @@ public final Flowable takeLast(long count, long time, @NonNull TimeUnit unit, * the length of the time window * @param unit * the time unit of {@code time} - * @return a {@code Flowable} that emits the items from the current {@code Flowable} that were emitted in the window of - * time before the current {@code Flowable} completed specified by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -16381,8 +16155,7 @@ public final Flowable takeLast(long time, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, an exception signaled by the current {@code Flowable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return a {@code Flowable} that emits the items from the current {@code Flowable} that were emitted in the window of - * time before the current {@code Flowable} completed specified by {@code time} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -16416,9 +16189,7 @@ public final Flowable takeLast(long time, @NonNull TimeUnit unit, boolean del * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that provides the timestamps for the observed items - * @return a {@code Flowable} that emits the items from the current {@code Flowable} that were emitted in the window of - * time before the current {@code Flowable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -16455,9 +16226,7 @@ public final Flowable takeLast(long time, @NonNull TimeUnit unit, @NonNull Sc * @param delayError * if {@code true}, an exception signaled by the current {@code Flowable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return a {@code Flowable} that emits the items from the current {@code Flowable} that were emitted in the window of - * time before the current {@code Flowable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -16496,9 +16265,7 @@ public final Flowable takeLast(long time, @NonNull TimeUnit unit, @NonNull Sc * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be last - * @return a {@code Flowable} that emits the items from the current {@code Flowable} that were emitted in the window of - * time before the current {@code Flowable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: TakeLast @@ -16530,8 +16297,7 @@ public final Flowable takeLast(long time, @NonNull TimeUnit unit, @NonNull Sc * * @param stopPredicate * a function that evaluates an item emitted by the current {@code Flowable} and returns a {@link Boolean} - * @return a {@code Flowable} that first emits items emitted by the current {@code Flowable}, checks the specified - * condition after each item, and then completes when the condition is satisfied. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code stopPredicate} is {@code null} * @see ReactiveX operators documentation: TakeUntil * @see Flowable#takeWhile(Predicate) @@ -16564,7 +16330,7 @@ public final Flowable takeUntil(@NonNull Predicate stopPredicate) * from the current {@code Flowable} * @param * the type of items emitted by {@code other} - * @return a {@code Flowable} that emits the items emitted by the current {@code Flowable} until such time as {@code other} emits its first item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: TakeUntil */ @@ -16592,8 +16358,7 @@ public final Flowable takeUntil(@NonNull Publisher other) { * * @param predicate * a function that evaluates an item emitted by the current {@code Flowable} and returns a {@link Boolean} - * @return a {@code Flowable} that emits the items from the current {@code Flowable} so long as each item satisfies the - * condition defined by {@code predicate}, then completes + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: TakeWhile * @see Flowable#takeUntil(Predicate) @@ -16626,7 +16391,7 @@ public final Flowable takeWhile(@NonNull Predicate predicate) { * time to wait before emitting another item after emitting the last item * @param unit * the unit of time of {@code windowDuration} - * @return a {@code Flowable} that performs the throttle operation + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -16661,7 +16426,7 @@ public final Flowable throttleFirst(long windowDuration, @NonNull TimeUnit un * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle timeout for each * event - * @return a {@code Flowable} that performs the throttle operation + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -16696,7 +16461,7 @@ public final Flowable throttleFirst(long skipDuration, @NonNull TimeUnit unit * emitted * @param unit * the unit of time of {@code intervalDuration} - * @return a {@code Flowable} that performs the throttle operation + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -16733,7 +16498,7 @@ public final Flowable throttleLast(long intervalDuration, @NonNull TimeUnit u * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle timeout for each * event - * @return a {@code Flowable} that performs the throttle operation + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see RxJava wiki: Backpressure @@ -16929,8 +16694,7 @@ public final Flowable throttleLatest(long timeout, @NonNull TimeUnit unit, @N * resulting {@code Flowable} * @param unit * the unit of time for the specified {@code timeout} - * @return a {@code Flowable} that filters out items from the current {@code Flowable} that are too quickly followed by - * newer items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Debounce * @see RxJava wiki: Backpressure @@ -16969,8 +16733,7 @@ public final Flowable throttleWithTimeout(long timeout, @NonNull TimeUnit uni * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle the timeout for each * item - * @return a {@code Flowable} that filters out items from the current {@code Flowable} that are too quickly followed by - * newer items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Debounce * @see RxJava wiki: Backpressure @@ -16998,7 +16761,7 @@ public final Flowable throttleWithTimeout(long timeout, @NonNull TimeUnit uni * from the {@code computation} {@link Scheduler}. * * - * @return a {@code Flowable} that emits time interval information items + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: TimeInterval */ @CheckReturnValue @@ -17025,7 +16788,7 @@ public final Flowable> timeInterval() { * * @param scheduler * the {@code Scheduler} used to compute time intervals - * @return a {@code Flowable} that emits time interval information items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -17052,7 +16815,7 @@ public final Flowable> timeInterval(@NonNull Scheduler scheduler) { * * * @param unit the time unit for the current time - * @return a {@code Flowable} that emits time interval information items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -17081,7 +16844,7 @@ public final Flowable> timeInterval(@NonNull TimeUnit unit) { * @param unit the time unit for the current time * @param scheduler * the {@code Scheduler} used to compute time intervals - * @return a {@code Flowable} that emits time interval information items + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -17119,9 +16882,7 @@ public final Flowable> timeInterval(@NonNull TimeUnit unit, @NonNull Sc * @param itemTimeoutIndicator * a function that returns a {@code Publisher} for each item emitted by the current * {@code Flowable} and that determines the timeout window for the subsequent item - * @return a {@code Flowable} that mirrors the current {@code Flowable}, but notifies {@code Subscriber}s of a - * {@code TimeoutException} if an item emitted by the current {@code Flowable} takes longer to arrive than - * the time window defined by the selector for the previously emitted item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code itemTimeoutIndicator} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17159,9 +16920,7 @@ public final Flowable timeout(@NonNull FunctionReactiveX operators documentation: Timeout */ @@ -17192,8 +16951,7 @@ public final Flowable timeout(@NonNull FunctionReactiveX operators documentation: Timeout */ @@ -17227,7 +16985,7 @@ public final Flowable timeout(long timeout, @NonNull TimeUnit unit) { * the unit of time that applies to the {@code timeout} argument * @param other * the fallback {@code Publisher} to use in case of a timeout - * @return the current {@code Flowable} modified to switch to the fallback {@code Publisher} in case of a timeout + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17265,8 +17023,7 @@ public final Flowable timeout(long timeout, @NonNull TimeUnit unit, @NonNull * the {@code Scheduler} to run the timeout timers on * @param other * the {@code Publisher} to use as the fallback in case of a timeout - * @return the current {@code Flowable} modified so that it will switch to the fallback {@code Publisher} in case of a - * timeout + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17300,8 +17057,7 @@ public final Flowable timeout(long timeout, @NonNull TimeUnit unit, @NonNull * the unit of time that applies to the {@code timeout} argument * @param scheduler * the {@code Scheduler} to run the timeout timers on - * @return the current {@code Flowable} modified to notify {@code Subscriber}s of a {@code TimeoutException} in case of a - * timeout + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17339,9 +17095,7 @@ public final Flowable timeout(long timeout, @NonNull TimeUnit unit, @NonNull * a function that returns a {@code Publisher} for each item emitted by the current {@code Flowable} and that * determines the timeout window in which the subsequent source item must arrive in order to * continue the sequence - * @return a {@code Flowable} that mirrors the current {@code Flowable}, but notifies {@code Subscriber}s of a - * {@code TimeoutException} if either the first item or any subsequent item doesn't arrive within - * the time windows specified by the timeout selectors + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code firstTimeoutIndicator} or {@code itemTimeoutIndicator} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17384,9 +17138,7 @@ public final Flowable timeout(@NonNull Publisher firstTimeoutIndica * continue the sequence * @param other * the fallback {@code Publisher} to switch to if the current {@code Flowable} times out - * @return a {@code Flowable} that mirrors the current {@code Flowable}, but switches to the {@code other} {@code Publisher} if - * either the first item emitted by the current {@code Flowable} or any subsequent item doesn't arrive - * within time windows defined by the timeout selectors + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code firstTimeoutIndicator}, {@code itemTimeoutIndicator} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -17432,7 +17184,7 @@ private Flowable timeout0( * from the {@code computation} {@link Scheduler}. * * - * @return a {@code Flowable} that emits timestamped items from the current {@code Flowable} + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Timestamp */ @CheckReturnValue @@ -17459,8 +17211,7 @@ public final Flowable> timestamp() { * * @param scheduler * the {@code Scheduler} to use as a time source - * @return a {@code Flowable} that emits timestamped items from the current {@code Flowable} with timestamps provided by - * the {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -17487,7 +17238,7 @@ public final Flowable> timestamp(@NonNull Scheduler scheduler) { * * * @param unit the time unit for the current time - * @return a {@code Flowable} that emits timestamped items from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -17516,8 +17267,7 @@ public final Flowable> timestamp(@NonNull TimeUnit unit) { * @param unit the time unit for the current time * @param scheduler * the {@code Scheduler} to use as a time source - * @return a {@code Flowable} that emits timestamped items from the current {@code Flowable} with timestamps provided by - * the {@code scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -17578,8 +17328,7 @@ public final R to(@NonNull FlowableConverter converter) { *
{@code toList} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a single item: a {@link List} containing all of the items emitted by the current - * {@code Flowable} + * @return the new {@code Single} instance * @see ReactiveX operators documentation: To */ @CheckReturnValue @@ -17615,8 +17364,7 @@ public final Single> toList() { * * @param capacityHint * the number of elements expected from the current {@code Flowable} - * @return a {@code Single} that emits a single item: a {@link List} containing all of the items emitted by the current - * {@code Flowable} + * @return the new {@code Single} instance * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To */ @@ -17655,8 +17403,7 @@ public final Single> toList(int capacityHint) { * @param the subclass of a collection of Ts * @param collectionSupplier * the {@link Supplier} returning the collection (for each individual {@code Subscriber}) to be filled in - * @return a {@code Single} that emits a single item: a {@link Collection} (subclass) containing all of the items emitted by the current - * {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code collectionSupplier} is {@code null} * @see ReactiveX operators documentation: To */ @@ -17691,8 +17438,7 @@ public final > Single toList(@NonNull Supplie * @param the key type of the Map * @param keySelector * the function that extracts the key from a source item to be used in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} containing the mapped items from the current - * {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -17731,8 +17477,7 @@ public final Single> toMap(@NonNull FunctionReactiveX operators documentation: To */ @@ -17771,8 +17516,7 @@ public final Single> toMap(@NonNull FunctionReactiveX operators documentation: To */ @@ -17807,8 +17551,7 @@ public final Single> toMap(@NonNull Function the key type of the Map * @param keySelector * the function that extracts the key from the source items to be used as key in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} that contains an {@code ArrayList} of items mapped from - * the current {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -17847,8 +17590,7 @@ public final Single>> toMultimap(@NonNull FunctionReactiveX operators documentation: To */ @@ -17890,8 +17632,7 @@ public final Single>> toMultimap(@NonNull FunctionReactiveX operators documentation: To */ @@ -17937,8 +17678,7 @@ public final Single>> toMultimap( * the function that extracts a value from the source items to be used as the value in the {@code Map} * @param mapSupplier * the function that returns a {@code Map} instance to be used - * @return a {@code Single} that emits a single item: a {@code Map} that contains a list items mapped from the current - * {@code Flowable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector}, {@code valueSelector} or {@code mapSupplier} is {@code null} * @see ReactiveX operators documentation: To */ @@ -17995,8 +17735,7 @@ public final Observable toObservable() { *
Scheduler:
*
{@code toSortedList} does not operate by default on a particular {@link Scheduler}.
* - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Flowable} in - * sorted order + * @return the new {@code Single} instance * @see ReactiveX operators documentation: To */ @CheckReturnValue @@ -18027,8 +17766,7 @@ public final Single> toSortedList() { * @param comparator * a function that compares two items emitted by the current {@code Flowable} and returns an {@code int} * that indicates their sort order - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Flowable} in - * sorted order + * @return the new {@code Single} instance * @throws NullPointerException if {@code comparator} is {@code null} * @see ReactiveX operators documentation: To */ @@ -18063,8 +17801,7 @@ public final Single> toSortedList(@NonNull Comparator compara * that indicates their sort order * @param capacityHint * the initial capacity of the {@link ArrayList} used to accumulate items before sorting - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Flowable} in - * sorted order + * @return the new {@code Single} instance * @throws NullPointerException if {@code comparator} is {@code null} * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To @@ -18103,8 +17840,7 @@ public final Single> toSortedList(@NonNull Comparator compara * * @param capacityHint * the initial capacity of the {@link ArrayList} used to accumulate items before sorting - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Flowable} in - * sorted order + * @return the new {@code Single} instance * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To * @since 2.0 @@ -18134,8 +17870,7 @@ public final Single> toSortedList(int capacityHint) { * * @param scheduler * the {@code Scheduler} to perform cancellation actions on - * @return the current {@code Flowable} modified so that its cancellations happen on the specified - * {@code Scheduler} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SubscribeOn */ @@ -18169,8 +17904,7 @@ public final Flowable unsubscribeOn(@NonNull Scheduler scheduler) { * * @param count * the maximum size of each window before it should be emitted - * @return a {@code Flowable} that emits connected, non-overlapping windows, each containing at most - * {@code count} items from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window */ @@ -18207,8 +17941,7 @@ public final Flowable> window(long count) { * @param skip * how many items need to be skipped before starting a new window. Note that if {@code skip} and * {@code count} are equal this is the same operation as {@link #window(long)}. - * @return a {@code Flowable} that emits windows every {@code skip} items containing at most {@code count} items - * from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Window */ @@ -18247,8 +17980,7 @@ public final Flowable> window(long count, long skip) { * {@code count} are equal this is the same operation as {@link #window(long)}. * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return a {@code Flowable} that emits windows every {@code skip} items containing at most {@code count} items - * from the current {@code Flowable} + * @return the new {@code Flowable} instance * @throws IllegalArgumentException if {@code count}, {@code skip} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window */ @@ -18293,7 +18025,7 @@ public final Flowable> window(long count, long skip, int bufferSize) * the period of time after which a new window will be created * @param unit * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments - * @return a {@code Flowable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18337,7 +18069,7 @@ public final Flowable> window(long timespan, long timeskip, @NonNull * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return a {@code Flowable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18383,7 +18115,7 @@ public final Flowable> window(long timespan, long timeskip, @NonNull * the {@code Scheduler} to use when determining the end and start of a window * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return a {@code Flowable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code timespan}, {@code timeskip} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -18428,8 +18160,7 @@ public final Flowable> window(long timespan, long timeskip, @NonNull * new window * @param unit * the unit of time that applies to the {@code timespan} argument - * @return a {@code Flowable} that emits connected, non-overlapping windows representing items emitted by the - * current {@code Flowable} during fixed, consecutive durations + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18471,9 +18202,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit) * the unit of time that applies to the {@code timespan} argument * @param count * the maximum size of each window before it should be emitted - * @return a {@code Flowable} that emits connected, non-overlapping windows of items from the current {@code Flowable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -18519,9 +18248,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit, * the maximum size of each window before it should be emitted * @param restart * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well - * @return a {@code Flowable} that emits connected, non-overlapping windows of items from the current {@code Flowable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -18565,8 +18292,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit, * the unit of time which applies to the {@code timespan} argument * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return a {@code Flowable} that emits connected, non-overlapping windows containing items emitted by the - * current {@code Flowable} within a fixed duration + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18611,9 +18337,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit, * the maximum size of each window before it should be emitted * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return a {@code Flowable} that emits connected, non-overlapping windows of items from the current {@code Flowable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -18661,9 +18385,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit, * the {@code Scheduler} to use when determining the end and start of a window * @param restart * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well - * @return a {@code Flowable} that emits connected, non-overlapping windows of items from the current {@code Flowable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -18713,9 +18435,7 @@ public final Flowable> window(long timespan, @NonNull TimeUnit unit, * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return a {@code Flowable} that emits connected, non-overlapping windows of items from the current {@code Flowable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count}, {@code timespan} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -18757,9 +18477,7 @@ public final Flowable> window( * the window element type (ignored) * @param boundaryIndicator * a {@code Publisher} whose emitted items close and open windows - * @return a {@code Flowable} that emits non-overlapping windows of items it collects from the current {@code Flowable} - * where the boundary of each window is determined by the items emitted from the {@code boundary} - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18796,9 +18514,7 @@ public final Flowable> window(@NonNull Publisher boundaryIndi * a {@code Publisher} whose emitted items close and open windows * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return a {@code Flowable} that emits non-overlapping windows of items it collects from the current {@code Flowable} - * where the boundary of each window is determined by the items emitted from the {@code boundary} - * {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -18842,8 +18558,7 @@ public final Flowable> window(@NonNull Publisher boundaryIndi * @param closingIndicator * a {@link Function} that produces a {@code Publisher} for every window created. When this {@code Publisher} * emits an item, the associated window is closed and emitted - * @return a {@code Flowable} that emits windows of items emitted by the current {@code Flowable} that are governed by - * the specified window-governing {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -18888,8 +18603,7 @@ public final Flowable> window( * emits an item, the associated window is closed and emitted * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return a {@code Flowable} that emits windows of items emitted by the current {@code Flowable} that are governed by - * the specified window-governing {@code Publisher}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -18929,9 +18643,7 @@ public final Flowable> window( * @param combiner * the function to call when the current {@code Flowable} emits an item and the other {@code Publisher} has already * emitted an item, to generate the item to be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that merges the specified {@code Publisher} into the current {@code Flowable} by using the - * {@code resultSelector} function only when the current {@code Flowable} sequence (this instance) emits an - * item + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} or {@code combiner} is {@code null} * @since 2.0 * @see ReactiveX operators documentation: CombineLatest @@ -19176,8 +18888,7 @@ public final Flowable withLatestFrom(@NonNull Iterable<@NonNull ? extends * @param zipper * a function that combines the pairs of items from the current {@code Flowable} and the {@code Iterable} to generate * the items to be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that pairs up values from the current {@code Flowable} and the {@code other} {@code Iterable} - * sequence and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -19226,8 +18937,7 @@ public final Flowable withLatestFrom(@NonNull Iterable<@NonNull ? extends * @param zipper * a function that combines the pairs of items from the two {@code Publisher}s to generate the items to * be emitted by the resulting {@code Flowable} - * @return a {@code Flowable} that pairs up values from the current {@code Flowable} and the {@code other} {@code Publisher} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -19277,8 +18987,7 @@ public final Flowable zipWith(@NonNull Publisher<@NonNull ? extends U> * be emitted by the resulting {@code Flowable} * @param delayError * if {@code true}, errors from the current {@code Flowable} or the other {@code Publisher} is delayed until both terminate - * @return a {@code Flowable} that pairs up values from the current {@code Flowable} and the {@code other} {@code Publisher} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip * @since 2.0 @@ -19331,8 +19040,7 @@ public final Flowable zipWith(@NonNull Publisher<@NonNull ? extends U> * the capacity hint for the buffer in the inner windows * @param delayError * if {@code true}, errors from the current {@code Flowable} or the other {@code Publisher} is delayed until both terminate - * @return a {@code Flowable} that pairs up values from the current {@code Flowable} and the {@code other} {@code Publisher} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip diff --git a/src/main/java/io/reactivex/rxjava3/core/Maybe.java b/src/main/java/io/reactivex/rxjava3/core/Maybe.java index 251127071f..82cb7545c2 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Maybe.java +++ b/src/main/java/io/reactivex/rxjava3/core/Maybe.java @@ -207,7 +207,7 @@ public static Flowable concat(@NonNull Iterable<@NonNull ? extends MaybeS * a {@code MaybeSource} to be concatenated * @param source2 * a {@code MaybeSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the two source {@code MaybeSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -239,7 +239,7 @@ public static Flowable concat(@NonNull MaybeSource source1, * a {@code MaybeSource} to be concatenated * @param source3 * a {@code MaybeSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the three source {@code MaybeSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -275,7 +275,7 @@ public static Flowable concat( * a {@code MaybeSource} to be concatenated * @param source4 * a {@code MaybeSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the four source {@code MaybeSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -643,7 +643,7 @@ public static Maybe defer(@NonNull Supplier{@code empty} does not operate by default on a particular {@link Scheduler}. * * @param the value type - * @return the new {@code Maybe} instance + * @return the shared {@code Maybe} instance */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -667,8 +667,7 @@ public static Maybe empty() { * the particular {@link Throwable} to pass to {@link MaybeObserver#onError onError} * @param * the type of the item (ostensibly) emitted by the {@code Maybe} - * @return a {@code Maybe} that invokes the subscriber's {@link MaybeObserver#onError onError} method when - * the subscriber subscribes to it + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code error} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -694,8 +693,7 @@ public static Maybe error(@NonNull Throwable error) { * a {@link Supplier} factory to return a {@link Throwable} for each individual {@code MaybeObserver} * @param * the type of the items (ostensibly) emitted by the {@code Maybe} - * @return a {@code Maybe} that invokes the {@code MaybeObserver.onError} method when - * the {@code MaybeObserver} subscribes to it + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -806,7 +804,7 @@ public static Maybe fromSingle(@NonNull SingleSource singleSource) { * {@code MaybeObserver} that subscribes to the returned {@code Maybe}. * @param * the type of the item emitted by the {@code Maybe}. - * @return a new {@code Maybe} instance + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code callable} is {@code null} * @see #defer(Supplier) * @see #fromSupplier(Supplier) @@ -841,7 +839,7 @@ public static Maybe fromSingle(@NonNull SingleSource singleSource) { * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Maybe} - * @return a {@code Maybe} that emits the item from the source {@code Future} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code future} is {@code null} * @see ReactiveX operators documentation: From */ @@ -879,7 +877,7 @@ public static Maybe fromSingle(@NonNull SingleSource singleSource) { * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Maybe} - * @return a {@code Maybe} that emits the item from the source {@code Future} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code future} or {@code unit} is {@code null} * @see ReactiveX operators documentation: From */ @@ -946,7 +944,7 @@ public static Maybe fromRunnable(@NonNull Runnable run) { * {@code MaybeObserver} that subscribes to the returned {@code Maybe}. * @param * the type of the item emitted by the {@code Maybe}. - * @return a new {@code Maybe} instance + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see #defer(Supplier) * @see #fromCallable(Callable) @@ -976,7 +974,7 @@ public static Maybe fromRunnable(@NonNull Runnable run) { * the item to emit * @param * the type of that item - * @return a {@code Maybe} that emits {@code item} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -1120,8 +1118,7 @@ public static Flowable merge(@NonNull Publisher<@NonNull ? extends MaybeS * @param the value type of the sources and the output * @param source * a {@code MaybeSource} that emits a {@code MaybeSource} - * @return a {@code Maybe} that emits the item that is the result of flattening the {@code MaybeSource} emitted - * by {@code source} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1166,7 +1163,7 @@ public static Maybe merge(@NonNull MaybeSourceReactiveX operators documentation: Merge * @see #mergeDelayError(MaybeSource, MaybeSource) @@ -1217,7 +1214,7 @@ public static Flowable merge( * a {@code MaybeSource} to be merged * @param source3 * a {@code MaybeSource} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the source {@code MaybeSource}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(MaybeSource, MaybeSource, MaybeSource) @@ -1272,7 +1269,7 @@ public static Flowable merge( * a {@code MaybeSource} to be merged * @param source4 * a {@code MaybeSource} to be merged - * @return a {@code Flowable} that emits all of the items emitted by the source {@code MaybeSource}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(MaybeSource, MaybeSource, MaybeSource, MaybeSource) @@ -1361,8 +1358,7 @@ public static Flowable mergeArray(MaybeSource... sources) { * @param the common element base type * @param sources * the array of {@code MaybeSource}s - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code MaybeSource}s in the array + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1403,8 +1399,7 @@ public static Flowable mergeArrayDelayError(@NonNull MaybeSource the common element base type * @param sources * the {@code Iterable} of {@code MaybeSource}s - * @return a {@code Flowable} that emits items that are the result of flattening the items emitted by the - * {@code MaybeSource}s in the {@code Iterable} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1441,8 +1436,7 @@ public static Flowable mergeDelayError(@NonNull Iterable<@NonNull ? exten * @param the common element base type * @param sources * a {@code Publisher} that emits {@code MaybeSource}s - * @return a {@code Flowable} that emits all of the items emitted by the {@code MaybeSource}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1479,8 +1473,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * @param sources * a {@code Publisher} that emits {@code MaybeSource}s * @param maxConcurrency the maximum number of active inner {@code MaybeSource}s to be merged at a time - * @return a {@code Flowable} that emits all of the items emitted by the {@code MaybeSource}s emitted by the - * {@code source} {@code Publisher} + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: Merge @@ -1522,7 +1515,7 @@ public static Flowable mergeDelayError(@NonNull Publisher<@NonNull ? exte * a {@code MaybeSource} to be merged * @param source2 * a {@code MaybeSource} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the two source {@code MaybeSource}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1564,7 +1557,7 @@ public static Flowable mergeDelayError(@NonNull MaybeSource * a {@code MaybeSource} to be merged * @param source3 * a {@code MaybeSource} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the source {@code MaybeSource}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1610,7 +1603,7 @@ public static Flowable mergeDelayError(@NonNull MaybeSource * a {@code MaybeSource} to be merged * @param source4 * a {@code MaybeSource} to be merged - * @return a {@code Flowable} that emits all of the items that are emitted by the source {@code MaybeSource}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -1641,7 +1634,7 @@ public static Flowable mergeDelayError( * * @param * the type of items (not) emitted by the {@code Maybe} - * @return a {@code Maybe} that never emits any items or sends any notifications to a {@code MaybeObserver} + * @return the shared {@code Maybe} instance * @see ReactiveX operators documentation: Never */ @CheckReturnValue @@ -1668,7 +1661,7 @@ public static Maybe never() { * the second {@code MaybeSource} to compare * @param * the type of items emitted by each {@code MaybeSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -1698,8 +1691,7 @@ public static Single sequenceEqual(@NonNull MaybeSource * the type of items emitted by each {@code MaybeSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two {@code MaybeSource} sequences - * are the same according to the specified function + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code isEqual} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -1727,7 +1719,7 @@ public static Single sequenceEqual(@NonNull MaybeSourceReactiveX operators documentation: Timer */ @@ -1753,7 +1745,7 @@ public static Maybe timer(long delay, @NonNull TimeUnit unit) { * time units to use for {@code delay} * @param scheduler * the {@code Scheduler} to use for scheduling the item - * @return a {@code Maybe} that emits {@code 0L} after a specified delay, on a specified {@code Scheduler} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timer */ @@ -1809,7 +1801,7 @@ public static Maybe unsafeCreate(@NonNull MaybeSource onSubscribe) { * the factory function to create a {@code MaybeSource} * @param resourceDisposer * the function that will dispose of the resource - * @return the {@code Maybe} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: Using */ @CheckReturnValue @@ -1847,7 +1839,7 @@ public static Maybe using(@NonNull Supplier resourceSuppl * or just before the emission of a terminal event ({@code onSuccess}, {@code onComplete} or {@code onError}). * If {@code false} the resource disposal will happen either on a {@code dispose()} call after the upstream is disposed * or just after the emission of a terminal event ({@code onSuccess}, {@code onComplete} or {@code onError}). - * @return the {@code Maybe} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code resourceSupplier}, {@code sourceSupplier} or {@code resourceDisposer} is {@code null} * @see ReactiveX operators documentation: Using */ @@ -1872,7 +1864,7 @@ public static Maybe using(@NonNull Supplier resourceSuppl * * @param the value type * @param source the source to wrap - * @return the {@code Maybe} wrapper or the source cast to {@code Maybe} (if possible) + * @return the new wrapped or cast {@code Maybe} instance * @throws NullPointerException if {@code source} is {@code null} */ @CheckReturnValue @@ -1910,7 +1902,7 @@ public static Maybe wrap(@NonNull MaybeSource source) { * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code zipper} or {@code sources} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -1946,7 +1938,7 @@ public static Maybe zip(@NonNull Iterable<@NonNull ? extends MaybeSour * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results * in an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -1988,7 +1980,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -2034,7 +2026,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -2086,7 +2078,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -2142,7 +2134,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -2205,7 +2197,7 @@ public static Maybe zip( * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7} or {@code zipper} is {@code null} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: Zip */ @CheckReturnValue @@ -2268,7 +2260,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8} or {@code zipper} is {@code null} @@ -2337,7 +2329,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8}, {@code source9} or {@code zipper} is {@code null} @@ -2389,7 +2381,7 @@ public static Maybe zip( * @param zipper * a function that, when applied to an item emitted by each of the source {@code MaybeSource}s, results in * an item that will be emitted by the resulting {@code Maybe} - * @return a {@code Maybe} that emits the zipped results + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -2423,8 +2415,7 @@ public static Maybe zipArray(@NonNull FunctionReactiveX operators documentation: Amb */ @@ -2498,8 +2489,7 @@ public final T blockingGet(@NonNull T defaultValue) { *
{@code cache} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Maybe} that, when first subscribed to, caches all of its items and notifications for the - * benefit of subsequent subscribers + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: Replay */ @CheckReturnValue @@ -2546,7 +2536,7 @@ public final Maybe cast(@NonNull Class clazz) { * * @param the value type of the {@code Maybe} returned by the transformer function * @param transformer the transformer function, not {@code null} - * @return a {@code Maybe}, transformed by the transformer function + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code transformer} is {@code null} * @see RxJava wiki: Implementing Your Own Operators */ @@ -2571,7 +2561,7 @@ public final Maybe compose(@NonNull MaybeTransformer the result value type * @param mapper * a function that, when applied to the item emitted by the current {@code Maybe}, returns a {@code MaybeSource} - * @return the {@code Maybe} returned from {@code mapper} when applied to the item emitted by the current {@code Maybe} + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: FlatMap * @throws NullPointerException if {@code mapper} is {@code null} */ @@ -2597,8 +2587,7 @@ public final Maybe concatMap(@NonNull FunctionReactiveX operators documentation: Concat */ @@ -2623,8 +2612,7 @@ public final Flowable concatWith(@NonNull MaybeSource other) { * * @param item * the item to search for in the emissions from the current {@code Maybe}, not {@code null} - * @return a {@code Single} that emits {@code true} if the specified item is emitted by the current {@code Maybe}, - * or {@code false} if the current {@code Maybe} completes without emitting that item + * @return the new {@code Single} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: Contains */ @@ -2646,8 +2634,7 @@ public final Single contains(@NonNull Object item) { *
{@code count} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a single item: the number of items emitted by the current {@code Maybe} as a - * 64-bit {@code Long} item + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Count */ @CheckReturnValue @@ -2669,8 +2656,7 @@ public final Single count() { * * @param defaultItem * the item to emit if the current {@code Maybe} emits no items - * @return a {@code Single} that emits either the specified default item if the current {@code Maybe} emits no - * item, or the item emitted by the current {@code Maybe} + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: DefaultIfEmpty */ @@ -2783,8 +2769,7 @@ public final Maybe delay(@NonNull Publisher delayIndicator) { * @param subscriptionIndicator the other {@code Publisher} that should trigger the subscription * to this {@code Publisher}. * @throws NullPointerException if {@code subscriptionIndicator} is {@code null} - * @return a {@code Maybe} that delays the subscription to this {@code Maybe} - * until the other {@code Publisher} emits an element or completes normally. + * @return the new {@code Maybe} instance */ @BackpressureSupport(BackpressureKind.UNBOUNDED_IN) @CheckReturnValue @@ -2808,7 +2793,7 @@ public final Maybe delaySubscription(@NonNull Publisher subscriptionIn * the time to delay the subscription * @param unit * the time unit of {@code delay} - * @return a {@code Maybe} that delays the subscription to the current {@code Maybe} by the given amount + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Delay * @see #delaySubscription(long, TimeUnit, Scheduler) @@ -2836,8 +2821,7 @@ public final Maybe delaySubscription(long delay, @NonNull TimeUnit unit) { * the time unit of {@code delay} * @param scheduler * the {@code Scheduler} on which the waiting and subscription will happen - * @return a {@code Maybe} that delays the subscription to the current {@code Maybe} by a given - * amount, waiting and subscribing on the given {@code Scheduler} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -2883,8 +2867,7 @@ public final Maybe doAfterSuccess(@NonNull Consumer onAfterSuccess * * @param onAfterTerminate * an {@code Action} to be invoked when the current {@code Maybe} finishes - * @return a {@code Maybe} that emits the same items as the current {@code Maybe}, then invokes the - * {@code Action} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code onAfterTerminate} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -3126,8 +3109,7 @@ public final Maybe doOnSuccess(@NonNull Consumer onSuccess) { * @param predicate * a function that evaluates the item emitted by the current {@code Maybe}, returning {@code true} * if it passes the filter - * @return a {@code Maybe} that emit the item emitted by the current {@code Maybe} that the filter - * evaluates as {@code true} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: Filter */ @@ -3153,7 +3135,7 @@ public final Maybe filter(@NonNull Predicate predicate) { * @param the result value type * @param mapper * a function that, when applied to the item emitted by the current {@code Maybe}, returns a {@code MaybeSource} - * @return the {@code Maybe} returned from {@code mapper} when applied to the item emitted by the current {@code Maybe} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap */ @@ -3304,7 +3286,7 @@ public final Observable flattenAsObservable(@NonNull Function the result value type * @param mapper * a function that, when applied to the item emitted by the current {@code Maybe}, returns an {@code ObservableSource} - * @return the {@code Observable} returned from {@code mapper} when applied to the item emitted by the current {@code Maybe} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap */ @@ -3332,7 +3314,7 @@ public final Observable flatMapObservable(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -3360,7 +3342,7 @@ public final Flowable flatMapPublisher(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -3414,7 +3396,7 @@ public final Maybe flatMapSingleElement(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -3454,8 +3436,7 @@ public final Maybe hide() { *
{@code ignoreElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return an empty {@code Completable} that only calls {@code onComplete} or {@code onError}, based on which one is - * called by the current {@code Maybe} + * @return the new {@code Completable} instance * @see ReactiveX operators documentation: IgnoreElements */ @CheckReturnValue @@ -3474,7 +3455,7 @@ public final Completable ignoreElement() { *
{@code isEmpty} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits {@code true} if the current {@code Maybe} is empty. + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Contains */ @CheckReturnValue @@ -3655,7 +3636,7 @@ public final Maybe lift(@NonNull MaybeOperator li * @param the result value type * @param mapper * a function to apply to the item emitted by the {@code Maybe} - * @return a {@code Maybe} that emits the item from the current {@code Maybe}, transformed by the specified function + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: Map */ @@ -3704,7 +3685,7 @@ public final Single> materialize() { * * @param other * a {@code MaybeSource} to be merged - * @return a new {@code Flowable} instance + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -4005,7 +3986,7 @@ public final Maybe onErrorReturnItem(@NonNull T item) { *
Scheduler:
*
{@code onTerminateDetach} does not operate by default on a particular {@link Scheduler}.
* - * @return a {@code Maybe} which {@code null}s out references to the upstream producer and downstream {@code MaybeObserver} if + * @return the new {@code Maybe} instance * the sequence is terminated or downstream calls {@code dispose()} */ @CheckReturnValue @@ -4026,7 +4007,7 @@ public final Maybe onTerminateDetach() { *
{@code repeat} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits the items emitted by the current {@code Maybe} repeatedly and in sequence + * @return the new {@code Flowable} instance * @see ReactiveX operators documentation: Repeat */ @BackpressureSupport(BackpressureKind.FULL) @@ -4052,8 +4033,7 @@ public final Flowable repeat() { * @param times * the number of times the current {@code Maybe} items are repeated, a count of 0 will yield an empty * sequence - * @return a {@code Flowable} that repeats the sequence of items emitted by the current {@code Maybe} at most - * {@code count} times + * @return the new {@code Flowable} instance * @throws IllegalArgumentException * if {@code times} is negative * @see ReactiveX operators documentation: Repeat @@ -4349,8 +4329,7 @@ public final Maybe retryWhen( *
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the {@code Maybe} has finished sending them + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @see ReactiveX operators documentation: Subscribe */ @SchedulerSupport(SchedulerSupport.NONE) @@ -4372,8 +4351,7 @@ public final Disposable subscribe() { * * @param onSuccess * the {@code Consumer} you have designed to accept a success value from the {@code Maybe} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the {@code Maybe} has finished sending them + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @throws NullPointerException * if {@code onSuccess} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -4398,8 +4376,7 @@ public final Disposable subscribe(@NonNull Consumer onSuccess) { * @param onError * the {@code Consumer} you have designed to accept any error notification from the * {@code Maybe} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the {@code Maybe} has finished sending them + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @see ReactiveX operators documentation: Subscribe * @throws NullPointerException * if {@code onSuccess} is {@code null}, or @@ -4428,8 +4405,7 @@ public final Disposable subscribe(@NonNull Consumer onSuccess, @NonNu * @param onComplete * the {@link Action} you have designed to accept a completion notification from the * {@code Maybe} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the {@code Maybe} has finished sending them + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @throws NullPointerException * if {@code onSuccess}, {@code onError} or * {@code onComplete} is {@code null} @@ -4487,7 +4463,7 @@ public final void subscribe(@NonNull MaybeObserver observer) { * * @param scheduler * the {@code Scheduler} to perform subscription actions on - * @return the new {@code Maybe} instance that its subscriptions happen on the specified {@code Scheduler} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SubscribeOn * @see RxJava Threading Examples @@ -4521,8 +4497,8 @@ public final Maybe subscribeOn(@NonNull Scheduler scheduler) { * * @param the type of the {@code MaybeObserver} to use and return * @param observer the {@code MaybeObserver} (subclass) to use and return, not {@code null} - * @return the input {@code subscriber} - * @throws NullPointerException if {@code subscriber} is {@code null} + * @return the input {@code observer} + * @throws NullPointerException if {@code observer} is {@code null} */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -4544,8 +4520,7 @@ public final Maybe subscribeOn(@NonNull Scheduler scheduler) { * * @param other * the alternate {@code MaybeSource} to subscribe to if the main does not emit any items - * @return a {@code Maybe} that emits the items emitted by the current {@code Maybe} or the items of an - * alternate {@code MaybeSource} if the current {@code Maybe} is empty. + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code other} is {@code null} */ @CheckReturnValue @@ -4568,8 +4543,7 @@ public final Maybe switchIfEmpty(@NonNull MaybeSource other) { *

History: 2.1.4 - experimental * @param other * the alternate {@code SingleSource} to subscribe to if the main does not emit any items - * @return a {@code Single} that emits the items emitted by the current {@code Maybe} or the item of an - * alternate {@code SingleSource} if the current {@code Maybe} is empty. + * @return the new {@code Single} instance * @throws NullPointerException if {@code other} is {@code null} * @since 2.2 */ @@ -4596,7 +4570,7 @@ public final Single switchIfEmpty(@NonNull SingleSource other) { * from the current {@code Maybe} * @param * the type of items emitted by {@code other} - * @return a {@code Maybe} that emits the items emitted by the current {@code Maybe} until such time as {@code other} emits its first item + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: TakeUntil */ @@ -4626,7 +4600,7 @@ public final Maybe takeUntil(@NonNull MaybeSource other) { * from the source {@code Publisher} * @param * the type of items emitted by {@code other} - * @return a {@code Maybe} that emits the items emitted by the current {@code Maybe} until such time as {@code other} emits its first item + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: TakeUntil */ diff --git a/src/main/java/io/reactivex/rxjava3/core/Observable.java b/src/main/java/io/reactivex/rxjava3/core/Observable.java index 2123f8e328..0ea4c18b47 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Observable.java +++ b/src/main/java/io/reactivex/rxjava3/core/Observable.java @@ -113,8 +113,7 @@ public abstract class Observable<@NonNull T> implements ObservableSource { * @param sources * an {@code Iterable} of {@code ObservableSource} sources competing to react first. A subscription to each source will * occur in the same order as in the {@code Iterable}. - * @return an {@code Observable} that emits the same sequence as whichever of the returned {@code ObservableSource}s first - * emitted an item or sent a termination notification + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -140,8 +139,7 @@ public static Observable amb(@NonNull Iterable<@NonNull ? extends Observa * @param sources * an array of {@code ObservableSource} sources competing to react first. A subscription to each source will * occur in the same order as in the array. - * @return an {@code Observable} that emits the same sequence as whichever of the returned {@code ObservableSource}s first - * emitted an item or sent a termination notification + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -205,8 +203,7 @@ public static int bufferSize() { * the collection of source {@code ObservableSource}s * @param combiner * the aggregation function used to combine the items emitted by the returned {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the returned - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -252,8 +249,7 @@ public static Observable combineLatest( * the aggregation function used to combine the items emitted by the returned {@code ObservableSource}s * @param bufferSize * the expected number of row combination items to be buffered internally - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the returned - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -304,8 +300,7 @@ public static Observable combineLatest( * the collection of source {@code ObservableSource}s * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the returned - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -351,8 +346,7 @@ public static Observable combineLatestArray( * the aggregation function used to combine the items emitted by the {@code ObservableSource}s * @param bufferSize * the expected number of row combination items to be buffered internally - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -399,8 +393,7 @@ public static Observable combineLatestArray( * the second source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -444,8 +437,7 @@ public static Observable combineLatest( * the third source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -494,8 +486,7 @@ public static Observable combineLatest( * the fourth source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -549,8 +540,7 @@ public static Observable combineLatest( * the fifth source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -609,8 +599,7 @@ public static Observable combineLatest( * the sixth source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest @@ -673,8 +662,7 @@ public static Observable combineLatest( * the seventh source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7} or {@code combiner} is {@code null} @@ -743,8 +731,7 @@ public static Observable combineLatest( * the eighth source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8} or {@code combiner} is {@code null} @@ -817,8 +804,7 @@ public static Observable combineLatest( * the ninth source {@code ObservableSource} * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8}, {@code source9} or {@code combiner} is {@code null} @@ -879,8 +865,7 @@ public static Observable combineLates * the collection of source {@code ObservableSource}s * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -927,8 +912,7 @@ public static Observable combineLatestArrayDelayError( * the aggregation function used to combine the items emitted by the {@code ObservableSource}s * @param bufferSize * the expected number of row combination items to be buffered internally - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -981,8 +965,7 @@ public static Observable combineLatestArrayDelayError(@NonNull Observa * the {@code Iterable} of source {@code ObservableSource}s * @param combiner * the aggregation function used to combine the items emitted by the {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @see ReactiveX operators documentation: CombineLatest */ @@ -1028,8 +1011,7 @@ public static Observable combineLatestDelayError(@NonNull Iterable<@No * the aggregation function used to combine the items emitted by the {@code ObservableSource}s * @param bufferSize * the expected number of row combination items to be buffered internally - * @return an {@code Observable} that emits items that are the result of combining the items emitted by the - * {@code ObservableSource}s by means of the given aggregation function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code combiner} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: CombineLatest @@ -1084,8 +1066,7 @@ public static Observable concat(@NonNull Iterable<@NonNull ? extends Obse * @param the common element base type * @param sources * an {@code ObservableSource} that emits {@code ObservableSource}s - * @return an {@code Observable} that emits items all of the items emitted by the {@code ObservableSource}s emitted by - * {@code ObservableSource}s, one after the other, without interleaving them + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1111,8 +1092,7 @@ public static Observable concat(@NonNull ObservableSourceReactiveX operators documentation: Concat @@ -1142,8 +1122,7 @@ public static Observable concat(@NonNull ObservableSourceReactiveX operators documentation: Concat */ @@ -1173,8 +1152,7 @@ public static Observable concat(@NonNull ObservableSource so * an {@code ObservableSource} to be concatenated * @param source3 * an {@code ObservableSource} to be concatenated - * @return an {@code Observable} that emits items emitted by the three source {@code ObservableSource}s, one after the other, - * without interleaving them + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1209,8 +1187,7 @@ public static Observable concat( * an {@code ObservableSource} to be concatenated * @param source4 * an {@code ObservableSource} to be concatenated - * @return an {@code Observable} that emits items emitted by the four source {@code ObservableSource}s, one after the other, - * without interleaving them + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1670,8 +1647,7 @@ public static Observable create(@NonNull ObservableOnSubscribe source) * resulting {@code Observable} * @param * the type of the items emitted by the {@code ObservableSource} - * @return an {@code Observable} whose {@code Observer}s' subscriptions trigger an invocation of the given - * {@code ObservableSource} factory function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see ReactiveX operators documentation: Defer */ @@ -1695,8 +1671,7 @@ public static Observable defer(@NonNull Supplier * the type of the items (ostensibly) emitted by the {@code Observable} - * @return an {@code Observable} that emits no items to the {@code Observer} but immediately invokes the - * {@code Observer}'s {@link Observer#onComplete() onComplete} method + * @return the shared {@code Observable} instance * @see ReactiveX operators documentation: Empty */ @CheckReturnValue @@ -1721,8 +1696,7 @@ public static Observable empty() { * a {@link Supplier} factory to return a {@link Throwable} for each individual {@code Observer} * @param * the type of the items (ostensibly) emitted by the {@code Observable} - * @return an {@code Observable} that invokes the {@code Observer}'s {@link Observer#onError onError} method when - * the {@code Observer} subscribes to it + * @return the new {@code Observable} instance * @throws NullPointerException if {@code errorSupplier} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -1748,8 +1722,7 @@ public static Observable error(@NonNull Supplier err * the particular {@link Throwable} to pass to {@link Observer#onError onError} * @param * the type of the items (ostensibly) emitted by the {@code Observable} - * @return an {@code Observable} that invokes the {@code Observer}'s {@link Observer#onError onError} method when - * the {@code Observer} subscribes to it + * @return the new {@code Observable} instance * @throws NullPointerException if {@code exception} is {@code null} * @see ReactiveX operators documentation: Throw */ @@ -1774,7 +1747,7 @@ public static Observable error(@NonNull Throwable exception) { * the array of elements * @param * the type of items in the array and the type of items to be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits each item in the source array + * @return the new {@code Observable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: From */ @@ -1817,7 +1790,7 @@ public static Observable fromArray(@NonNull T... items) { * function only when an observer subscribes to the {@code Observable} that {@code fromCallable} returns * @param * the type of the item returned by the {@code Callable} and emitted by the {@code Observable} - * @return an {@code Observable} whose {@link Observer}s' subscriptions trigger an invocation of the given function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code callable} is {@code null} * @see #defer(Supplier) * @see #fromSupplier(Supplier) @@ -1857,7 +1830,7 @@ public static Observable fromCallable(@NonNull Callable call * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Observable} - * @return an {@code Observable} that emits the item from the source {@code Future} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code future} is {@code null} * @see ReactiveX operators documentation: From */ @@ -1899,7 +1872,7 @@ public static Observable fromFuture(@NonNull Future future) * @param * the type of object that the {@code Future} returns, and also the type of item to be emitted by * the resulting {@code Observable} - * @return an {@code Observable} that emits the item from the source {@code Future} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code future} or {@code unit} is {@code null} * @see ReactiveX operators documentation: From */ @@ -1926,7 +1899,7 @@ public static Observable fromFuture(@NonNull Future future, * @param * the type of items in the {@code Iterable} sequence and the type of items to be emitted by the * resulting {@code Observable} - * @return an {@code Observable} that emits each item in the source {@code Iterable} sequence + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source} is {@code null} * @see ReactiveX operators documentation: From * @see #fromStream(Stream) @@ -2000,7 +1973,7 @@ public static Observable fromPublisher(@NonNull Publisher<@NonNull ? exte * function only when an observer subscribes to the {@code Observable} that {@code fromSupplier} returns * @param * the type of the item emitted by the {@code Observable} - * @return an {@code Observable} whose {@link Observer}s' subscriptions trigger an invocation of the given function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code supplier} is {@code null} * @see #defer(Supplier) * @see #fromCallable(Callable) @@ -2200,8 +2173,7 @@ public static Observable generate(@NonNull Supplier initialState, @ * the period of time between emissions of the subsequent numbers * @param unit * the time unit for both {@code initialDelay} and {@code period} - * @return an {@code Observable} that emits a 0L after the {@code initialDelay} and ever increasing numbers after - * each {@code period} of time thereafter + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Interval * @throws NullPointerException if {@code unit} is {@code null} * @since 1.0.12 @@ -2231,8 +2203,7 @@ public static Observable interval(long initialDelay, long period, @NonNull * the time unit for both {@code initialDelay} and {@code period} * @param scheduler * the {@code Scheduler} on which the waiting happens and items are emitted - * @return an {@code Observable} that emits a 0L after the {@code initialDelay} and ever increasing numbers after - * each {@code period} of time thereafter, while running on the given {@code Scheduler} + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Interval * @since 1.0.12 * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} @@ -2260,7 +2231,7 @@ public static Observable interval(long initialDelay, long period, @NonNull * the period size in time units (see below) * @param unit * time units to use for the interval size - * @return an {@code Observable} that emits a sequential number each time interval + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Interval */ @@ -2287,7 +2258,7 @@ public static Observable interval(long period, @NonNull TimeUnit unit) { * time units to use for the interval size * @param scheduler * the {@code Scheduler} to use for scheduling the items - * @return an {@code Observable} that emits a sequential number each time interval + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Interval */ @@ -2390,7 +2361,7 @@ public static Observable intervalRange(long start, long count, long initia * the item to emit * @param * the type of that item - * @return an {@code Observable} that emits {@code value} as a single item and then completes + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: Just * @see #just(Object, Object) @@ -2421,7 +2392,7 @@ public static Observable just(@NonNull T item) { * second item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1} or {@code item2} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -2452,7 +2423,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2) { * third item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2} or {@code item3} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -2486,7 +2457,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * fourth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3} or {@code item4} is {@code null} * @see ReactiveX operators documentation: Just */ @@ -2523,7 +2494,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * fifth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4} or {@code item5} is {@code null} * @see ReactiveX operators documentation: Just @@ -2564,7 +2535,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * sixth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5} or {@code item6} is {@code null} * @see ReactiveX operators documentation: Just @@ -2608,7 +2579,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * seventh item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6} * or {@code item7} is {@code null} @@ -2656,7 +2627,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * eighth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6} * {@code item7} or {@code item8} is {@code null} @@ -2707,7 +2678,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * ninth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6} * {@code item7}, {@code item8} or {@code item9} is {@code null} @@ -2761,7 +2732,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * tenth item * @param * the type of these items - * @return an {@code Observable} that emits each item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item1}, {@code item2}, {@code item3}, * {@code item4}, {@code item5}, {@code item6} * {@code item7}, {@code item8}, {@code item9} @@ -2819,8 +2790,7 @@ public static Observable just(@NonNull T item1, @NonNull T item2, @NonNul * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently * @param bufferSize * the number of items expected from each inner {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrent} or {@code bufferSize} is non-positive @@ -2868,8 +2838,7 @@ public static Observable merge(@NonNull Iterable<@NonNull ? extends Obser * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently * @param bufferSize * the number of items expected from each inner {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the array + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrent} or {@code bufferSize} is non-positive @@ -2913,8 +2882,7 @@ public static Observable mergeArray(int maxConcurrency, int bufferSize, @ * @param the common element base type * @param sources * the {@code Iterable} of {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(Iterable) @@ -2958,8 +2926,7 @@ public static Observable merge(@NonNull Iterable<@NonNull ? extends Obser * the {@code Iterable} of {@code ObservableSource}s * @param maxConcurrency * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException * if {@code maxConcurrency} is less than or equal to 0 @@ -3003,8 +2970,7 @@ public static Observable merge(@NonNull Iterable<@NonNull ? extends Obser * @param the common element base type * @param sources * an {@code ObservableSource} that emits {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of flattening the {@code ObservableSource}s emitted by the - * {@code source} {@code ObservableSource} + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Merge * @throws NullPointerException if {@code sources} is {@code null} * @see #mergeDelayError(ObservableSource) @@ -3050,8 +3016,7 @@ public static Observable merge(@NonNull ObservableSource Observable merge(@NonNull ObservableSourceReactiveX operators documentation: Merge * @see #mergeDelayError(ObservableSource, ObservableSource) @@ -3146,7 +3111,7 @@ public static Observable merge(@NonNull ObservableSource sou * an {@code ObservableSource} to be merged * @param source3 * an {@code ObservableSource} to be merged - * @return an {@code Observable} that emits all of the items emitted by the {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(ObservableSource, ObservableSource, ObservableSource) @@ -3198,7 +3163,7 @@ public static Observable merge( * an {@code ObservableSource} to be merged * @param source4 * an {@code ObservableSource} to be merged - * @return an {@code Observable} that emits all of the items emitted by the {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeDelayError(ObservableSource, ObservableSource, ObservableSource, ObservableSource) @@ -3245,7 +3210,7 @@ public static Observable merge( * @param the common element base type * @param sources * the array of {@code ObservableSource}s - * @return an {@code Observable} that emits all of the items emitted by the {@code ObservableSource}s in the array + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge * @see #mergeArrayDelayError(ObservableSource...) @@ -3280,8 +3245,7 @@ public static Observable mergeArray(@NonNull ObservableSource the common element base type * @param sources * the {@code Iterable} of {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3318,8 +3282,7 @@ public static Observable mergeDelayError(@NonNull Iterable<@NonNull ? ext * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently * @param bufferSize * the number of items expected from each inner {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Merge @@ -3357,8 +3320,7 @@ public static Observable mergeDelayError(@NonNull Iterable<@NonNull ? ext * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently * @param bufferSize * the number of items expected from each inner {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the array + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Merge @@ -3395,8 +3357,7 @@ public static Observable mergeArrayDelayError(int maxConcurrency, int buf * the {@code Iterable} of {@code ObservableSource}s * @param maxConcurrency * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the {@code Iterable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: Merge @@ -3430,8 +3391,7 @@ public static Observable mergeDelayError(@NonNull Iterable<@NonNull ? ext * @param the common element base type * @param sources * an {@code ObservableSource} that emits {@code ObservableSource}s - * @return an {@code Observable} that emits all of the items emitted by the {@code ObservableSource}s emitted by the - * {@code source} {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3468,8 +3428,7 @@ public static Observable mergeDelayError(@NonNull ObservableSourceReactiveX operators documentation: Merge @@ -3508,7 +3467,7 @@ public static Observable mergeDelayError(@NonNull ObservableSourceReactiveX operators documentation: Merge */ @@ -3549,7 +3508,7 @@ public static Observable mergeDelayError( * an {@code ObservableSource} to be merged * @param source3 * an {@code ObservableSource} to be merged - * @return an {@code Observable} that emits all of the items that are emitted by the {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3594,7 +3553,7 @@ public static Observable mergeDelayError( * an {@code ObservableSource} to be merged * @param source4 * an {@code ObservableSource} to be merged - * @return an {@code Observable} that emits all of the items that are emitted by the {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3633,8 +3592,7 @@ public static Observable mergeDelayError( * @param the common element base type * @param sources * the array of {@code ObservableSource}s - * @return an {@code Observable} that emits items that are the result of flattening the items emitted by the - * {@code ObservableSource}s in the array + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3660,7 +3618,7 @@ public static Observable mergeArrayDelayError(@NonNull ObservableSource * the type of items (not) emitted by the {@code Observable} - * @return an {@code Observable} that never emits any items or sends any notifications to an {@code Observer} + * @return the shared {@code Observable} instance * @see ReactiveX operators documentation: Never */ @CheckReturnValue @@ -3684,7 +3642,7 @@ public static Observable never() { * the value of the first {@code Integer} in the sequence * @param count * the number of sequential {@code Integer}s to generate - * @return an {@code Observable} that emits a range of sequential {@code Integer}s + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code count} is negative, or if {@code start} + {@code count} − 1 exceeds * {@link Integer#MAX_VALUE} @@ -3722,7 +3680,7 @@ public static Observable range(int start, int count) { * the value of the first {@code Long} in the sequence * @param count * the number of sequential {@code Long}s to generate - * @return an {@code Observable} that emits a range of sequential {@code Long}s + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code count} is negative, or if {@code start} + {@code count} − 1 exceeds * {@link Long#MAX_VALUE} @@ -3768,7 +3726,7 @@ public static Observable rangeLong(long start, long count) { * the second {@code ObservableSource} to compare * @param * the type of items emitted by each {@code ObservableSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -3798,8 +3756,7 @@ public static Single sequenceEqual(@NonNull ObservableSource * the type of items emitted by each {@code ObservableSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two {@code ObservableSource} two sequences - * are the same according to the specified function + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code isEqual} is {@code null} * @see ReactiveX operators documentation: SequenceEqual */ @@ -3833,8 +3790,7 @@ public static Single sequenceEqual( * the number of items expected from the first and second source {@code ObservableSource} to be buffered * @param * the type of items emitted by each {@code ObservableSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two {@code ObservableSource} two sequences - * are the same according to the specified function + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code isEqual} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SequenceEqual @@ -3870,7 +3826,7 @@ public static Single sequenceEqual( * the number of items expected from the first and second source {@code ObservableSource} to be buffered * @param * the type of items emitted by each {@code ObservableSource} - * @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same + * @return the new {@code Single} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SequenceEqual @@ -3906,8 +3862,7 @@ public static Single sequenceEqual(@NonNull ObservableSourceReactiveX operators documentation: Switch @@ -3943,8 +3898,7 @@ public static Observable switchOnNext(@NonNull ObservableSource the item type * @param sources * the {@code ObservableSource} that emits {@code ObservableSource}s - * @return an {@code Observable} that emits the items emitted by the {@code ObservableSource} most recently emitted by the {@code sources} - * {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Switch */ @@ -3977,8 +3931,7 @@ public static Observable switchOnNext(@NonNull ObservableSource the item type * @param sources * the {@code ObservableSource} that emits {@code ObservableSource}s - * @return an {@code Observable} that emits the items emitted by the {@code ObservableSource} most recently emitted by the {@code sources} - * {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @see ReactiveX operators documentation: Switch * @since 2.0 @@ -4014,8 +3967,7 @@ public static Observable switchOnNextDelayError(@NonNull ObservableSource * the {@code ObservableSource} that emits {@code ObservableSource}s * @param bufferSize * the expected number of items to cache from the inner {@code ObservableSource}s - * @return an {@code Observable} that emits the items emitted by the {@code ObservableSource} most recently emitted by the {@code sources} - * {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Switch @@ -4044,7 +3996,7 @@ public static Observable switchOnNextDelayError(@NonNull ObservableSource * the initial delay before emitting a single {@code 0L} * @param unit * time units to use for {@code delay} - * @return an {@code Observable} that {@code 0L} after a specified delay, and then completes + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Timer */ @@ -4073,8 +4025,7 @@ public static Observable timer(long delay, @NonNull TimeUnit unit) { * the {@code Scheduler} to use for scheduling the item * @throws NullPointerException * if {@code unit} or {@code scheduler} is {@code null} - * @return an {@code Observable} that emits {@code 0L} after a specified delay, on a specified {@code Scheduler}, and then - * completes + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Timer */ @CheckReturnValue @@ -4133,7 +4084,7 @@ public static Observable unsafeCreate(@NonNull ObservableSource onSubs * the factory function to create an {@code ObservableSource} * @param resourceDisposer * the function that will dispose of the resource - * @return the {@code ObservableSource} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Using */ @CheckReturnValue @@ -4170,7 +4121,7 @@ public static Observable using( * or just before the emission of a terminal event ({@code onComplete} or {@code onError}). * If {@code false}, the resource disposal will happen either on a {@code dispose()} call after the upstream is disposed * or just after the emission of a terminal event ({@code onComplete} or {@code onError}). - * @return the {@code ObservableSource} whose lifetime controls the lifetime of the dependent resource object + * @return the new {@code Observable} instance * @throws NullPointerException if {@code resourceSupplier}, {@code sourceSupplier} and {@code resourceDisposer} is {@code null} * @see ReactiveX operators documentation: Using * @since 2.0 @@ -4254,7 +4205,7 @@ public static Observable wrap(@NonNull ObservableSource source) { * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4314,7 +4265,7 @@ public static Observable zip(@NonNull Iterable<@NonNull ? extends Obse * the number of elements expected from each source {@code ObservableSource} to be buffered * @param the common source value type * @param the zipped result type - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -4372,7 +4323,7 @@ public static Observable zip(@NonNull Iterable<@NonNull ? extends Obse * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results * in an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4430,7 +4381,7 @@ public static Observable zip( * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results * in an item that will be emitted by the resulting {@code Observable} * @param delayError delay errors from any of the {@code ObservableSource}s till the other terminates - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4489,7 +4440,7 @@ public static Observable zip( * in an item that will be emitted by the resulting {@code Observable} * @param delayError delay errors from any of the {@code ObservableSource}s till the other terminates * @param bufferSize the number of elements expected from each source {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -4551,7 +4502,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -4617,7 +4568,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -4688,7 +4639,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -4762,7 +4713,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip @@ -4840,7 +4791,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7} or {@code zipper} is {@code null} @@ -4924,7 +4875,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8} or {@code zipper} is {@code null} @@ -5012,7 +4963,7 @@ public static Observable zip( * @param zipper * a function that, when applied to an item emitted by each of the {@code ObservableSource}s, results in * an item that will be emitted by the resulting {@code Observable} - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3}, * {@code source4}, {@code source5}, {@code source6}, * {@code source7}, {@code source8}, {@code source9} or {@code zipper} is {@code null} @@ -5086,7 +5037,7 @@ public static Observable zip( * delay errors signaled by any of the {@code ObservableSource} until all {@code ObservableSource}s terminate * @param bufferSize * the number of elements expected from each source {@code ObservableSource} to be buffered - * @return an {@code Observable} that emits the zipped results + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sources} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Zip @@ -5124,8 +5075,7 @@ public static Observable zipArray( * * @param predicate * a function that evaluates an item and returns a {@code Boolean} - * @return a {@code Single} that emits {@code true} if all items emitted by the current {@code Observable} satisfy the - * predicate; otherwise, {@code false} + * @return the new {@code Single} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: All */ @@ -5150,8 +5100,7 @@ public final Single all(@NonNull Predicate predicate) { * @param other * an {@code ObservableSource} competing to react first. A subscription to this provided source will occur after * subscribing to the current source. - * @return an {@code Observable} that emits the same sequence as whichever of the current {@code Observable}s first - * emitted an item or sent a termination notification + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Amb */ @@ -5179,8 +5128,7 @@ public final Observable ambWith(@NonNull ObservableSource other) * * @param predicate * the condition to test items emitted by the current {@code Observable} - * @return a {@code Single} that emits a {@link Boolean} that indicates whether any item emitted by the current - * {@code Observable} satisfies the {@code predicate} + * @return the new {@code Single} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: Contains */ @@ -5460,7 +5408,7 @@ public final T blockingLast(@NonNull T defaultItem) { *

{@code blockingLatest} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Iterable} that always returns the latest item emitted by the current {@code Observable} + * @return the new {@code Iterable} instance * @see ReactiveX documentation: First */ @CheckReturnValue @@ -5483,8 +5431,7 @@ public final Iterable blockingLatest() { * @param initialValue * the initial value that the {@code Iterable} sequence will yield if the current * {@code Observable} has not yet emitted an item - * @return an {@code Iterable} that on each iteration returns the item that the current {@code Observable} - * has most recently emitted + * @return the new {@code Iterable} instance * @see ReactiveX documentation: First */ @CheckReturnValue @@ -5504,8 +5451,7 @@ public final Iterable blockingMostRecent(@NonNull T initialValue) { *
{@code blockingNext} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Iterable} that blocks upon each iteration until the current {@code Observable} emits - * a new item, whereupon the {@code Iterable} returns that item + * @return the new {@code Iterable} instance * @see ReactiveX documentation: TakeLast */ @CheckReturnValue @@ -5588,7 +5534,7 @@ public final T blockingSingle(@NonNull T defaultItem) { *
{@code toFuture} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Future} that expects a single item to be emitted by the current {@code Observable} + * @return the new {@code Future} instance * @see ReactiveX documentation: To * @see #singleOrErrorStage() */ @@ -5734,8 +5680,7 @@ public final void blockingSubscribe(@NonNull Observer observer) { * * @param count * the maximum number of items in each buffer before it should be emitted - * @return an {@code Observable} that emits connected, non-overlapping buffers, each containing at most - * {@code count} items from the current {@code Observable} + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer */ @@ -5765,8 +5710,7 @@ public final void blockingSubscribe(@NonNull Observer observer) { * how many items emitted by the current {@code Observable} should be skipped before starting a new * buffer. Note that when {@code skip} and {@code count} are equal, this is the same operation as * {@link #buffer(int)}. - * @return an {@code Observable} that emits buffers for every {@code skip} item from the current {@code Observable} and - * containing at most {@code count} items + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Buffer */ @@ -5800,8 +5744,7 @@ public final void blockingSubscribe(@NonNull Observer observer) { * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return an {@code Observable} that emits buffers for every {@code skip} item from the current {@code Observable} and - * containing at most {@code count} items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Buffer @@ -5835,8 +5778,7 @@ public final > Observable buffer(int count, i * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return an {@code Observable} that emits connected, non-overlapping buffers, each containing at most - * {@code count} items from the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -5868,8 +5810,7 @@ public final > Observable buffer(int count, i * the period of time after which a new buffer will be created * @param unit * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments - * @return an {@code Observable} that emits new buffers of items emitted by the current {@code Observable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -5903,8 +5844,7 @@ public final > Observable buffer(int count, i * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments * @param scheduler * the {@code Scheduler} to use when determining the end and start of a buffer - * @return an {@code Observable} that emits new buffers of items emitted by the current {@code Observable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -5942,8 +5882,7 @@ public final > Observable buffer(int count, i * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return an {@code Observable} that emits new buffers of items emitted by the current {@code Observable} periodically after - * a fixed timespan has elapsed + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code bufferSupplier} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -5976,8 +5915,7 @@ public final > Observable buffer(int count, i * buffer * @param unit * the unit of time that applies to the {@code timespan} argument - * @return an {@code Observable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Observable} within a fixed duration + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6010,9 +5948,7 @@ public final > Observable buffer(int count, i * the unit of time which applies to the {@code timespan} argument * @param count * the maximum size of each buffer before it is emitted - * @return an {@code Observable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Observable}, after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6048,9 +5984,7 @@ public final > Observable buffer(int count, i * the {@code Scheduler} to use when determining the end and start of a buffer * @param count * the maximum size of each buffer before it is emitted - * @return an {@code Observable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Observable} after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6092,9 +6026,7 @@ public final > Observable buffer(int count, i * as the buffer * @param restartTimerOnMaxSize if {@code true}, the time window is restarted when the max capacity of the current buffer * is reached - * @return an {@code Observable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Observable} after a fixed duration or when the buffer reaches maximum capacity (whichever occurs - * first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code bufferSupplier} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Buffer @@ -6135,8 +6067,7 @@ public final > Observable buffer(int count, i * the unit of time which applies to the {@code timespan} argument * @param scheduler * the {@code Scheduler} to use when determining the end and start of a buffer - * @return an {@code Observable} that emits connected, non-overlapping buffers of items emitted by the current - * {@code Observable} within a fixed duration + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6167,8 +6098,7 @@ public final > Observable buffer(int count, i * @param closingIndicator * the {@link Function} that is used to produce an {@code ObservableSource} for every buffer created. When this indicator * {@code ObservableSource} emits an item, the associated buffer is emitted. - * @return an {@code Observable} that emits buffers, containing items from the current {@code Observable}, that are created - * and closed when the specified {@code ObservableSource}s emit items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6205,8 +6135,7 @@ public final > Observable buffer(int count, i * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return an {@code Observable} that emits buffers, containing items from the current {@code Observable}, that are created - * and closed when the specified {@code ObservableSource}s emit items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code openingIndicator}, {@code closingIndicator} or {@code bufferSupplier} is {@code null} * @see ReactiveX operators documentation: Buffer */ @@ -6242,8 +6171,7 @@ public final > Observable buffer(int count, i * the boundary value type (ignored) * @param boundaryIndicator * the boundary {@code ObservableSource} - * @return an {@code Observable} that emits buffered items from the current {@code Observable} when the boundary {@code ObservableSource} - * emits an item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @see #buffer(ObservableSource, int) * @see ReactiveX operators documentation: Buffer @@ -6276,8 +6204,7 @@ public final > Observable buffer(int count, i * the boundary {@code ObservableSource} * @param initialCapacity * the initial capacity of each buffer chunk - * @return an {@code Observable} that emits buffered items from the current {@code Observable} when the boundary {@code ObservableSource} - * emits an item + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Buffer * @throws NullPointerException if {@code boundaryIndicator} is {@code null} * @throws IllegalArgumentException if {@code initialCapacity} is non-positive @@ -6314,8 +6241,7 @@ public final > Observable buffer(int count, i * @param bufferSupplier * a factory function that returns an instance of the collection subclass to be used and returned * as the buffer - * @return an {@code Observable} that emits buffered items from the current {@code Observable} when the boundary {@code ObservableSource} - * emits an item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code boundary} or {@code bufferSupplier} is {@code null} * @see #buffer(ObservableSource, int) * @see ReactiveX operators documentation: Buffer @@ -6373,8 +6299,7 @@ public final > Observable buffer(int count, i *
{@code cache} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that, when first subscribed to, caches all of its items and notifications for the - * benefit of subsequent subscribers + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Replay * @see #takeUntil(Predicate) * @see #takeUntil(ObservableSource) @@ -6434,8 +6359,7 @@ public final Observable cache() { * {@link #replay(int)} in combination with {@link ConnectableObservable#autoConnect()} or similar. * * @param initialCapacity hint for number of items to cache (for optimizing underlying data structure) - * @return an {@code Observable} that, when first subscribed to, caches all of its items and notifications for the - * benefit of subsequent subscribers + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code initialCapacity} is non-positive * @see ReactiveX operators documentation: Replay * @see #takeUntil(Predicate) @@ -6463,8 +6387,7 @@ public final Observable cacheWithInitialCapacity(int initialCapacity) { * @param clazz * the target class type that {@code cast} will cast the items emitted by the current {@code Observable} * into before emitting them from the resulting {@code Observable} - * @return an {@code Observable} that emits each item from the current {@code Observable} after converting it to the - * specified type + * @return the new {@code Observable} instance * @throws NullPointerException if {@code clazz} is {@code null} * @see ReactiveX operators documentation: Map */ @@ -6498,8 +6421,7 @@ public final Observable cast(@NonNull Class clazz) { * @param collector * a function that accepts the {@code state} and an emitted item, and modifies the accumulator accordingly * accordingly - * @return a {@code Single} that emits the result of collecting the values emitted by the current {@code Observable} - * into a single mutable data structure + * @return the new {@code Single} instance * @throws NullPointerException if {@code initialValueSupplier} or {@code collector} is {@code null} * @see ReactiveX operators documentation: Reduce */ @@ -6534,8 +6456,7 @@ public final Single collect(@NonNull Supplier initialValueSu * @param collector * a function that accepts the {@code state} and an emitted item, and modifies the accumulator accordingly * accordingly - * @return a {@code Single} that emits the result of collecting the values emitted by the current {@code Observable} - * into a single mutable data structure + * @return the new {@code Single} instance * @throws NullPointerException if {@code initialValue} or {@code collector} is {@code null} * @see ReactiveX operators documentation: Reduce */ @@ -6563,7 +6484,7 @@ public final Single collectInto(@NonNull U initialValue, @NonNull BiConsu * * @param the value type of the output {@code ObservableSource} * @param composer implements the function that transforms the current {@code Observable} - * @return the current {@code Observable}, transformed by the transformer function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code composer} is {@code null} * @see RxJava wiki: Implementing Your Own Operators */ @@ -6594,8 +6515,7 @@ public final Observable compose(@NonNull ObservableTransformerReactiveX operators documentation: FlatMap * @see #concatMap(Function, int, Scheduler) @@ -6628,8 +6548,7 @@ public final Observable concatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -6674,8 +6593,7 @@ public final Observable concatMap(@NonNull Function Observable concatMapEagerDelayError(@NonNull FunctionHistory: 2.1.6 - experimental * @param mapper * a function that, when applied to an item emitted by the current {@code Observable}, returns a {@code CompletableSource} - * @return a {@link Completable} that signals {@code onComplete} when the upstream and all {@code CompletableSource}s complete + * @return the new {@link Completable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @since 2.2 */ @@ -6974,7 +6892,7 @@ public final Completable concatMapCompletable(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -7127,7 +7044,7 @@ public final Observable concatMapIterable(@NonNull Function Observable concatMapMaybe(@NonNull Function Observable concatMapMaybe(@NonNull Function Observable concatMapMaybeDelayError(@NonNull Function Observable concatMapMaybeDelayError(@NonNull Function Observable concatMapMaybeDelayError(@NonNull Function Observable concatMapSingle(@NonNull Function Observable concatMapSingle(@NonNull Function Observable concatMapSingleDelayError(@NonNull Function Observable concatMapSingleDelayError(@NonNull Function Observable concatMapSingleDelayError(@NonNull FunctionReactiveX operators documentation: Concat */ @@ -7540,8 +7456,7 @@ public final Observable concatWith(@NonNull CompletableSource other) { * * @param element * the item to search for in the emissions from the current {@code Observable} - * @return a {@code Single} that emits {@code true} if the specified item is emitted by the current {@code Observable}, - * or {@code false} if the current {@code Observable} completes without emitting that item + * @return the new {@code Single} instance * @throws NullPointerException if {@code element} is {@code null} * @see ReactiveX operators documentation: Contains */ @@ -7563,8 +7478,7 @@ public final Single contains(@NonNull Object element) { *
{@code count} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a single item: the number of items emitted by the current {@code Observable} as a - * 64-bit {@code Long} item + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Count */ @CheckReturnValue @@ -7597,8 +7511,7 @@ public final Single count() { * the debounce value type (ignored) * @param debounceSelector * function to return a sequence that indicates the throttle duration for each item via its own emission or completion - * @return an {@code Observable} that omits items emitted by the current {@code Observable} that are followed by another item - * within a computed debounce duration + * @return the new {@code Observable} instance * @throws NullPointerException if {@code debounceSelector} is {@code null} * @see ReactiveX operators documentation: Debounce */ @@ -7637,8 +7550,7 @@ public final Observable debounce(@NonNull FunctionReactiveX operators documentation: Debounce * @see #throttleWithTimeout(long, TimeUnit) @@ -7679,8 +7591,7 @@ public final Observable debounce(long timeout, @NonNull TimeUnit unit) { * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle the timeout for each * item - * @return an {@code Observable} that filters out items from the current {@code Observable} that are too quickly followed by - * newer items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Debounce * @see #throttleWithTimeout(long, TimeUnit, Scheduler) @@ -7706,8 +7617,7 @@ public final Observable debounce(long timeout, @NonNull TimeUnit unit, @NonNu * * @param defaultItem * the item to emit if the current {@code Observable} emits no items - * @return an {@code Observable} that emits either the specified default item if the current {@code Observable} emits no - * items, or the items emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: DefaultIfEmpty */ @@ -7738,8 +7648,7 @@ public final Observable defaultIfEmpty(@NonNull T defaultItem) { * a function that returns an {@code ObservableSource} for each item emitted by the current {@code Observable}, which is * then used to delay the emission of that item by the resulting {@code Observable} until the {@code ObservableSource} * returned from {@code itemDelay} emits an item - * @return an {@code Observable} that delays the emissions of the current {@code Observable} via another {@code ObservableSource} on a - * per-item basis + * @return the new {@code Observable} instance * @throws NullPointerException if {@code itemDelay} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -7765,7 +7674,7 @@ public final Observable delay(@NonNull FunctionReactiveX operators documentation: Delay * @see #delay(long, TimeUnit, boolean) @@ -7795,7 +7704,7 @@ public final Observable delay(long delay, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, the upstream exception is signaled with the given delay, after all preceding normal elements, * if {@code false}, the upstream exception is signaled immediately - * @return the current {@code Observable} shifted in time by the specified delay + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Delay * @see #delay(long, TimeUnit, Scheduler, boolean) @@ -7823,7 +7732,7 @@ public final Observable delay(long delay, @NonNull TimeUnit unit, boolean del * the time unit of {@code delay} * @param scheduler * the {@code Scheduler} to use for delaying - * @return the current {@code Observable} shifted in time by the specified delay + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -7853,7 +7762,7 @@ public final Observable delay(long delay, @NonNull TimeUnit unit, @NonNull Sc * @param delayError * if {@code true}, the upstream exception is signaled with the given delay, after all preceding normal elements, * if {@code false}, the upstream exception is signaled immediately - * @return the current {@code Observable} shifted in time by the specified delay + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -7891,8 +7800,7 @@ public final Observable delay(long delay, @NonNull TimeUnit unit, @NonNull Sc * a function that returns an {@code ObservableSource} for each item emitted by the current {@code Observable}, which is * then used to delay the emission of that item by the resulting {@code Observable} until the {@code ObservableSource} * returned from {@code itemDelay} emits an item - * @return an {@code Observable} that delays the subscription and emissions of the current {@code Observable} via another - * {@code ObservableSource} on a per-item basis + * @return the new {@code Observable} instance * @throws NullPointerException if {@code subscriptionDelay} or {@code itemDelay} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -7917,8 +7825,7 @@ public final Observable delay(@NonNull ObservableSource subscriptio * @param the value type of the other {@code Observable}, irrelevant * @param other the other {@code ObservableSource} that should trigger the subscription * to the current {@code Observable}. - * @return an {@code Observable} that delays the subscription to the current {@code Observable} - * until the other {@code ObservableSource} emits an element or completes normally. + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @since 2.0 */ @@ -7943,7 +7850,7 @@ public final Observable delaySubscription(@NonNull ObservableSource ot * the time to delay the subscription * @param unit * the time unit of {@code delay} - * @return an {@code Observable} that delays the subscription to the current {@code Observable} by the given amount + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -7970,8 +7877,7 @@ public final Observable delaySubscription(long delay, @NonNull TimeUnit unit) * the time unit of {@code delay} * @param scheduler * the {@code Scheduler} on which the waiting and subscription will happen - * @return an {@code Observable} that delays the subscription to the current {@code Observable} by a given - * amount, waiting and subscribing on the given {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Delay */ @@ -8024,8 +7930,7 @@ public final Observable delaySubscription(long delay, @NonNull TimeUnit unit, * @param the output value type * @param selector function that returns the upstream item and should return a {@code Notification} to signal * the corresponding {@code Observer} event to the downstream. - * @return an {@code Observable} that emits the items and notifications embedded in the {@code Notification} objects - * selected from the items emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Dematerialize * @since 3.0.0 @@ -8063,8 +7968,7 @@ public final Observable dematerialize(@NonNull Function{@code distinct} does not operate by default on a particular {@link Scheduler}. * * - * @return an {@code Observable} that emits only those items emitted by the current {@code Observable} that are distinct from - * each other + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Distinct * @see #distinct(Function) * @see #distinct(Function, Supplier) @@ -8106,7 +8010,7 @@ public final Observable distinct() { * @param keySelector * a function that projects an emitted item to a key value that is used to decide whether an item * is distinct from another one or not - * @return an {@code Observable} that emits those items emitted by the current {@code Observable} that have distinct keys + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: Distinct * @see #distinct(Function, Supplier) @@ -8140,7 +8044,7 @@ public final Observable distinct(@NonNull Function keySelec * @param collectionSupplier * function called for each individual {@link Observer} to return a {@link Collection} subtype for holding the extracted * keys and whose {@code add()} method's return indicates uniqueness. - * @return an {@code Observable} that emits those items emitted by the current {@code Observable} that have distinct keys + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} or {@code collectionSupplier} is {@code null} * @see ReactiveX operators documentation: Distinct */ @@ -8179,8 +8083,7 @@ public final Observable distinct(@NonNull Function keySelec *
{@code distinctUntilChanged} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that emits those items from the current {@code Observable} that are distinct from their - * immediate predecessors + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Distinct * @see #distinctUntilChanged(BiPredicate) */ @@ -8223,8 +8126,7 @@ public final Observable distinctUntilChanged() { * @param keySelector * a function that projects an emitted item to a key value that is used to decide whether an item * is distinct from another one or not - * @return an {@code Observable} that emits those items from the current {@code Observable} whose keys are distinct from - * those of their immediate predecessors + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: Distinct */ @@ -8258,8 +8160,7 @@ public final Observable distinctUntilChanged(@NonNull FunctionReactiveX operators documentation: Distinct * @since 2.0 @@ -8311,8 +8212,7 @@ public final Observable doAfterNext(@NonNull Consumer onAfterNext) * * @param onAfterTerminate * an {@code Action} to be invoked after the current {@code Observable} finishes - * @return an {@code Observable} that emits the same items as the current {@code Observable}, then invokes the - * {@code Action} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onAfterTerminate} is {@code null} * @see ReactiveX operators documentation: Do * @see #doOnTerminate(Action) @@ -8371,7 +8271,7 @@ public final Observable doFinally(@NonNull Action onFinally) { * * @param onDispose * the action that gets called when the current {@code Observable}'s {@link Disposable} is disposed - * @return the current {@code Observable} modified so as to call this {@code Action} when appropriate + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onDispose} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8393,7 +8293,7 @@ public final Observable doOnDispose(@NonNull Action onDispose) { * * @param onComplete * the action to invoke when the current {@code Observable} calls {@code onComplete} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onComplete} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8414,7 +8314,7 @@ public final Observable doOnComplete(@NonNull Action onComplete) { *
{@code doOnEach} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onNext}, {@code onError}, {@code onComplete} or {@code onAfterTerminate} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8441,7 +8341,7 @@ private Observable doOnEach(@NonNull Consumer onNext, @NonNull Con * * @param onNotification * the action to invoke for each item emitted by the current {@code Observable} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onNotification} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8476,7 +8376,7 @@ public final Observable doOnEach(@NonNull Consumer> o * @param observer * the observer to be notified about {@code onNext}, {@code onError} and {@code onComplete} events on its * respective methods before the actual downstream {@code Observer} gets notified. - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code observer} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8507,7 +8407,7 @@ public final Observable doOnEach(@NonNull Observer observer) { * * @param onError * the action to invoke if the current {@code Observable} calls {@code onError} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onError} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8532,7 +8432,7 @@ public final Observable doOnError(@NonNull Consumer onErro * a {@link Consumer} called with the {@link Disposable} sent via {@link Observer#onSubscribe(Disposable)} * @param onDispose * called when the downstream disposes the {@code Disposable} via {@code dispose()} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onSubscribe} or {@code onDispose} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8556,7 +8456,7 @@ public final Observable doOnLifecycle(@NonNull Consumer o * * @param onNext * the action to invoke when the current {@code Observable} calls {@code onNext} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onNext} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8581,7 +8481,7 @@ public final Observable doOnNext(@NonNull Consumer onNext) { * * @param onSubscribe * the {@code Consumer} that gets called when an {@code Observer} subscribes to the current {@code Observable} - * @return the current {@code Observable} modified so as to call this {@code Consumer} whenever it gets subscribed + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onSubscribe} is {@code null} * @see ReactiveX operators documentation: Do */ @@ -8607,7 +8507,7 @@ public final Observable doOnSubscribe(@NonNull Consumer o * * @param onTerminate * the action to invoke when the current {@code Observable} calls {@code onComplete} or {@code onError} - * @return the current {@code Observable} with the side-effecting behavior applied + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onTerminate} is {@code null} * @see ReactiveX operators documentation: Do * @see #doAfterTerminate(Action) @@ -8634,8 +8534,7 @@ public final Observable doOnTerminate(@NonNull Action onTerminate) { * * @param index * the zero-based index of the item to retrieve - * @return a {@code Maybe} that emits a single item: the item at the specified position in the sequence of - * those emitted by the current {@code Observable} + * @return the new {@code Maybe} instance * @throws IndexOutOfBoundsException * if {@code index} is negative * @see ReactiveX operators documentation: ElementAt @@ -8664,8 +8563,7 @@ public final Maybe elementAt(long index) { * the zero-based index of the item to retrieve * @param defaultItem * the default item - * @return a {@code Single} that emits the item at the specified position in the sequence emitted by the current - * {@code Observable}, or the default item if that index is outside the bounds of the source sequence + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @throws IndexOutOfBoundsException * if {@code index} is negative @@ -8694,8 +8592,7 @@ public final Single elementAt(long index, @NonNull T defaultItem) { * * @param index * the zero-based index of the item to retrieve - * @return a {@code Single} that emits the item at the specified position in the sequence emitted by the current - * {@code Observable}, or the default item if that index is outside the bounds of the source sequence + * @return the new {@code Single} instance * @throws IndexOutOfBoundsException * if {@code index} is negative * @see ReactiveX operators documentation: ElementAt @@ -8722,8 +8619,7 @@ public final Single elementAtOrError(long index) { * @param predicate * a function that evaluates each item emitted by the current {@code Observable}, returning {@code true} * if it passes the filter - * @return an {@code Observable} that emits only those items emitted by the current {@code Observable} that the filter - * evaluates as {@code true} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: Filter */ @@ -8813,9 +8709,7 @@ public final Single firstOrError() { * @param mapper * a function that, when applied to an item emitted by the current {@code Observable}, returns an * {@code ObservableSource} - * @return an {@code Observable} that emits the result of applying the transformation function to each item emitted - * by the current {@code Observable} and merging the results of the {@code ObservableSource}s obtained from this - * transformation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap */ @@ -8844,9 +8738,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -8878,9 +8770,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -8916,9 +8806,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -8963,8 +8851,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -9004,8 +8891,7 @@ public final Observable flatMap( * {@code Observable} * @param maxConcurrency * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently - * @return an {@code Observable} that emits the results of merging the {@code ObservableSource}s returned from applying the - * specified functions to the emissions and notifications of the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code onNextMapper} or {@code onErrorMapper} or {@code onCompleteSupplier} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: FlatMap @@ -9043,9 +8929,7 @@ public final Observable flatMap( * {@code ObservableSource} * @param maxConcurrency * the maximum number of {@code ObservableSource}s that may be subscribed to concurrently - * @return an {@code Observable} that emits the result of applying the transformation function to each item emitted - * by the current {@code Observable} and merging the results of the {@code ObservableSource}s obtained from this - * transformation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @throws IllegalArgumentException if {@code maxConcurrency} is non-positive * @see ReactiveX operators documentation: FlatMap @@ -9077,8 +8961,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -9112,8 +8995,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap */ @@ -9150,8 +9032,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -9192,8 +9073,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -9231,8 +9111,7 @@ public final Observable flatMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -9590,9 +9469,7 @@ public final Disposable forEachWhile(@NonNull Predicate onNext, @NonN * a function that extracts the key for each item * @param * the key type - * @return an {@code Observable} that emits {@code GroupedObservable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Observable} that share that - * key value + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: GroupBy */ @@ -9637,9 +9514,7 @@ public final Observable> groupBy(@NonNull FunctionReactiveX operators documentation: GroupBy */ @@ -9685,9 +9560,7 @@ public final Observable> groupBy(@NonNull Function * the element type - * @return an {@code Observable} that emits {@code GroupedObservable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Observable} that share that - * key value + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @see ReactiveX operators documentation: GroupBy */ @@ -9736,9 +9609,7 @@ public final Observable> groupBy(@NonNull Functio * @param delayError * if {@code true}, the exception from the current {@code Observable} is delayed in each group until that specific group emitted * the normal values; if {@code false}, the exception bypasses values in the groups and is reported immediately. - * @return an {@code Observable} that emits {@code GroupedObservable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Observable} that share that - * key value + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @see ReactiveX operators documentation: GroupBy */ @@ -9789,9 +9660,7 @@ public final Observable> groupBy(@NonNull Functio * the key type * @param * the element type - * @return an {@code Observable} that emits {@code GroupedObservable}s, each of which corresponds to a - * unique key value and each of which emits those items from the current {@code Observable} that share that - * key value + * @return the new {@code Observable} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: GroupBy @@ -9836,8 +9705,7 @@ public final Observable> groupBy(@NonNull Functio * @param resultSelector * a function that takes an item emitted by each {@code ObservableSource} and returns the value to be emitted * by the resulting {@code Observable} - * @return an {@code Observable} that emits items based on combining those items emitted by the current {@code Observable}s - * whose durations overlap + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other}, {@code leftEnd}, {@code rightEnd} or {@code resultSelector} is {@code null} * @see ReactiveX operators documentation: Join */ @@ -9912,7 +9780,7 @@ public final Completable ignoreElements() { *
{@code isEmpty} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a {@link Boolean} + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Contains */ @CheckReturnValue @@ -9949,8 +9817,7 @@ public final Single isEmpty() { * @param resultSelector * a function that computes an item to be emitted by the resulting {@code Observable} for any two * overlapping items emitted by the two {@code ObservableSource}s - * @return an {@code Observable} that emits items correlating to items emitted by the current {@code Observable}s that have - * overlapping durations + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other}, {@code leftEnd}, {@code rightEnd} or {@code resultSelector} is {@code null} * @see ReactiveX operators documentation: Join */ @@ -9981,8 +9848,7 @@ public final Observable join( *
{@code lastElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Maybe} that emits the last item from the current {@code Observable} or notifies observers of an - * error + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: Last */ @CheckReturnValue @@ -10004,8 +9870,7 @@ public final Maybe lastElement() { * * @param defaultItem * the default item to emit if the current {@code Observable} is empty - * @return a {@code Single} that emits only the last item emitted by the current {@code Observable}, or a default item - * if the current {@code Observable} is empty + * @return the new {@code Single} instance * @throws NullPointerException if {@code defaultItem} is {@code null} * @see ReactiveX operators documentation: Last */ @@ -10027,8 +9892,7 @@ public final Single last(@NonNull T defaultItem) { *
{@code lastOrError} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits only the last item emitted by the current {@code Observable}. - * If the current {@code Observable} completes without emitting any items a {@code NoSuchElementException} will be thrown. + * @return the new {@code Single} instance * @see ReactiveX operators documentation: Last */ @CheckReturnValue @@ -10202,8 +10066,7 @@ public final Observable lift(@NonNull ObservableOperator the output type * @param mapper * a function to apply to each item emitted by the current {@code Observable} - * @return an {@code Observable} that emits the items from the current {@code Observable}, transformed by the specified - * function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: Map */ @@ -10225,8 +10088,7 @@ public final Observable map(@NonNull Function map *
{@code materialize} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that emits items that are the result of materializing the items and notifications - * of the current {@code Observable} + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Materialize * @see #dematerialize(Function) */ @@ -10251,7 +10113,7 @@ public final Observable> materialize() { * * @param other * an {@code ObservableSource} to be merged - * @return an {@code Observable} that emits all of the items emitted by the current {@code Observable}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -10359,8 +10221,7 @@ public final Observable mergeWith(@NonNull CompletableSource other) { * * @param scheduler * the {@code Scheduler} to notify {@link Observer}s on - * @return the current {@code Observable} modified so that its {@code Observer}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: ObserveOn * @see RxJava Threading Examples @@ -10399,8 +10260,7 @@ public final Observable observeOn(@NonNull Scheduler scheduler) { * indicates if the {@code onError} notification may not cut ahead of {@code onNext} notification on the other side of the * scheduling boundary. If {@code true}, a sequence ending in {@code onError} will be replayed in the same order as was received * from the current {@code Observable} - * @return the current {@code Observable} modified so that its {@code Observer}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: ObserveOn * @see RxJava Threading Examples @@ -10440,8 +10300,7 @@ public final Observable observeOn(@NonNull Scheduler scheduler, boolean delay * scheduling boundary. If {@code true} a sequence ending in {@code onError} will be replayed in the same order as was received * from upstream * @param bufferSize the size of the buffer. - * @return the current {@code Observable} modified so that its {@code Observer}s are notified on the specified - * {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: ObserveOn @@ -10472,7 +10331,7 @@ public final Observable observeOn(@NonNull Scheduler scheduler, boolean delay * @param the output type * @param clazz * the class type to filter the items emitted by the current {@code Observable} - * @return an {@code Observable} that emits items from the current {@code Observable} of type {@code clazz} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code clazz} is {@code null} * @see ReactiveX operators documentation: Filter */ @@ -10510,7 +10369,7 @@ public final Observable ofType(@NonNull Class clazz) { * @param resumeFunction * a function that returns an {@code ObservableSource} that will take over if the current {@code Observable} encounters * an error - * @return the original {@code ObservableSource}, with appropriately modified behavior + * @return the new {@code Observable} instance * @throws NullPointerException if {@code resumeFunction} is {@code null} * @see ReactiveX operators documentation: Catch */ @@ -10548,7 +10407,7 @@ public final Observable onErrorResumeNext(@NonNull FunctionReactiveX operators documentation: Catch */ @@ -10583,7 +10442,7 @@ public final Observable onErrorResumeWith(@NonNull ObservableSourceReactiveX operators documentation: Catch */ @@ -10617,7 +10476,7 @@ public final Observable onErrorReturn(@NonNull FunctionReactiveX operators documentation: Catch */ @@ -10638,7 +10497,7 @@ public final Observable onErrorReturnItem(@NonNull T item) { *
Scheduler:
*
{@code onTerminateDetach} does not operate by default on a particular {@link Scheduler}.
* - * @return an {@code Observable} which {@code null}s out references to the upstream producer and downstream {@code Observer} if + * @return the new {@code Observable} instance * the sequence is terminated or downstream calls {@code dispose()} * @since 2.0 */ @@ -10660,8 +10519,7 @@ public final Observable onTerminateDetach() { *
{@code publish} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code ConnectableObservable} that upon connection causes the current {@code Observable} to emit items - * to its {@code Observer}s + * @return the new {@code ConnectableObservable} instance * @see ReactiveX operators documentation: Publish */ @CheckReturnValue @@ -10687,8 +10545,7 @@ public final ConnectableObservable publish() { * a function that can use the multicasted source sequence as many times as needed, without * causing multiple subscriptions to the source sequence. {@link Observer}s to the given source will * receive all notifications of the source from the time of the subscription forward. - * @return an {@code Observable} that emits the results of invoking the selector on the items - * emitted by a {@code ConnectableObservable} that shares a single subscription to the underlying sequence + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Publish */ @@ -10723,8 +10580,7 @@ public final Observable publish(@NonNull Function, * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Observable}, whose * result will be used in the next accumulator call - * @return a {@code Maybe} that emits a single item that is the result of accumulating the items emitted by - * the current {@code Observable} + * @return the new {@code Maybe} instance * @throws NullPointerException if {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -10781,8 +10637,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Observable}, the * result of which will be used in the next accumulator call - * @return a {@code Single} that emits a single item that is the result of accumulating the output from the - * items emitted by the current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code seed} or {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -10824,8 +10679,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { * @param reducer * an accumulator function to be invoked on each item emitted by the current {@code Observable}, the * result of which will be used in the next accumulator call - * @return a {@code Single} that emits a single item that is the result of accumulating the output from the - * items emitted by the current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code seedSupplier} or {@code reducer} is {@code null} * @see ReactiveX operators documentation: Reduce * @see Wikipedia: Fold (higher-order function) @@ -10848,7 +10702,7 @@ public final Maybe reduce(@NonNull BiFunction reducer) { *
{@code repeat} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} repeatedly and in sequence + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Repeat */ @CheckReturnValue @@ -10871,8 +10725,7 @@ public final Observable repeat() { * @param times * the number of times the current {@code Observable} items are repeated, a count of 0 will yield an empty * sequence - * @return an {@code Observable} that repeats the sequence of items emitted by the current {@code Observable} at most - * {@code count} times + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code times} is negative * @see ReactiveX operators documentation: Repeat @@ -10957,8 +10810,7 @@ public final Observable repeatWhen(@NonNull FunctionThis version of {@code replay} does not operate by default on a particular {@link Scheduler}. * * - * @return a {@code ConnectableObservable} that upon connection causes the current {@code Observable} to emit its - * items to its {@code Observer}s + * @return the new {@code ConnectableObservable} instance * @see ReactiveX operators documentation: Replay */ @CheckReturnValue @@ -10983,8 +10835,7 @@ public final ConnectableObservable replay() { * @param selector * the selector function, which can use the multicasted sequence as many times as needed, without * causing multiple subscriptions to the current {@code Observable} - * @return an {@code Observable} that emits items that are the results of invoking the selector on a - * {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -11017,9 +10868,7 @@ public final Observable replay(@NonNull Function, ? * causing multiple subscriptions to the current {@code Observable} * @param bufferSize * the buffer size that limits the number of items the connectable {@code Observable} can replay - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} - * replaying no more than {@code bufferSize} items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -11058,9 +10907,7 @@ public final Observable replay(@NonNull Function, ? * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} - * replaying no more than {@code bufferSize} items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -11099,10 +10946,7 @@ public final Observable replay(@NonNull Function, ? * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} or {@code unit} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -11141,10 +10985,7 @@ public final Observable replay(@NonNull Function, ? * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that is the time source for the window - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code bufferSize} is non-positive * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} @@ -11194,10 +11035,7 @@ public final Observable replay(@NonNull Function, ? * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, and - * replays no more than {@code bufferSize} items that were emitted within the window defined by - * {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code bufferSize} is non-positive @@ -11235,9 +11073,7 @@ public final Observable replay(@NonNull Function, ? * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector} or {@code unit} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -11270,9 +11106,7 @@ public final Observable replay(@NonNull Function, ? * the time unit of {@code time} * @param scheduler * the scheduler that is the time source for the window - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay * @see #replay(Function, long, TimeUnit, Scheduler, boolean) @@ -11312,9 +11146,7 @@ public final Observable replay(@NonNull Function, ? * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return an {@code Observable} that emits items that are the results of invoking the selector on items emitted by - * a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable}, - * replaying all items that were emitted within the window defined by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code selector}, {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -11347,8 +11179,7 @@ public final Observable replay(@NonNull Function, ? * * @param bufferSize * the buffer size that limits the number of items that can be replayed - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays at most {@code bufferSize} items emitted by the current {@code Observable} + * @return the new {@code ConnectableObservable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay * @see #replay(int, boolean) @@ -11382,8 +11213,7 @@ public final ConnectableObservable replay(int bufferSize) { * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays at most {@code bufferSize} items emitted by the current {@code Observable} + * @return the new {@code ConnectableObservable} instance * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay */ @@ -11418,9 +11248,7 @@ public final ConnectableObservable replay(int bufferSize, boolean eagerTrunca * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableObservable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Replay @@ -11458,9 +11286,7 @@ public final ConnectableObservable replay(int bufferSize, long time, @NonNull * the time unit of {@code time} * @param scheduler * the scheduler that is used as a time source for the window - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableObservable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code bufferSize} is non-positive @@ -11502,9 +11328,7 @@ public final ConnectableObservable replay(int bufferSize, long time, @NonNull * the time unit of {@code time} * @param scheduler * the scheduler that is used as a time source for the window - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays at most {@code bufferSize} items that were emitted during the window defined by - * {@code time} + * @return the new {@code ConnectableObservable} instance * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention @@ -11539,8 +11363,7 @@ public final ConnectableObservable replay(int bufferSize, long time, @NonNull * the duration of the window in which the replayed items must have been emitted * @param unit * the time unit of {@code time} - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableObservable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -11572,8 +11395,7 @@ public final ConnectableObservable replay(long time, @NonNull TimeUnit unit) * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that is the time source for the window - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableObservable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay * @see #replay(long, TimeUnit, Scheduler, boolean) @@ -11611,8 +11433,7 @@ public final ConnectableObservable replay(long time, @NonNull TimeUnit unit, * @param eagerTruncate * if {@code true}, whenever the internal buffer is truncated to the given bufferSize/age, the * oldest item will be guaranteed dereferenced, thus avoiding unexpected retention - * @return a {@code ConnectableObservable} that shares a single subscription to the current {@code Observable} and - * replays the items that were emitted during the window defined by {@code time} + * @return the new {@code ConnectableObservable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Replay */ @@ -11643,7 +11464,7 @@ public final ConnectableObservable replay(long time, @NonNull TimeUnit unit, *
{@code retry} does not operate by default on a particular {@link Scheduler}.
* * - * @return the current {@code Observable} modified with retry logic + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Retry */ @CheckReturnValue @@ -11666,7 +11487,7 @@ public final Observable retry() { * @param predicate * the predicate that determines if a resubscription may happen in case of a specific exception * and retry count - * @return the current {@code Observable} modified with retry logic + * @return the new {@code Observable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see #retry() * @see ReactiveX operators documentation: Retry @@ -11701,7 +11522,7 @@ public final Observable retry(@NonNull BiPredicateReactiveX operators documentation: Retry */ @@ -11848,7 +11669,7 @@ public final Observable retryUntil(@NonNull BooleanSupplier stop) { * @param handler * receives an {@code Observable} of notifications with which a user can complete or error, aborting the * retry - * @return the current {@code Observable} modified with retry logic + * @return the new {@code Observable} instance * @throws NullPointerException if {@code handler} is {@code null} * @see ReactiveX operators documentation: Retry */ @@ -11898,8 +11719,7 @@ public final void safeSubscribe(@NonNull Observer observer) { * the sampling rate * @param unit * the {@link TimeUnit} in which {@code period} is defined - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} at - * the specified time interval + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see #throttleLast(long, TimeUnit) @@ -11926,12 +11746,11 @@ public final Observable sample(long period, @NonNull TimeUnit unit) { * the sampling rate * @param unit * the {@link TimeUnit} in which {@code period} is defined - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} at - * the specified time interval * @param emitLast * if {@code true} and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see #throttleLast(long, TimeUnit) @@ -11960,8 +11779,7 @@ public final Observable sample(long period, @NonNull TimeUnit unit, boolean e * the {@link TimeUnit} in which {@code period} is defined * @param scheduler * the {@code Scheduler} to use when sampling - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} at - * the specified time interval + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see #throttleLast(long, TimeUnit, Scheduler) @@ -11997,8 +11815,7 @@ public final Observable sample(long period, @NonNull TimeUnit unit, @NonNull * if {@code true} and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} at - * the specified time interval + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see #throttleLast(long, TimeUnit, Scheduler) @@ -12027,8 +11844,7 @@ public final Observable sample(long period, @NonNull TimeUnit unit, @NonNull * @param the element type of the sampler {@code ObservableSource} * @param sampler * the {@code ObservableSource} to use for sampling the current {@code Observable} - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} whenever - * the {@code sampler} {@code ObservableSource} emits an item or completes + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sampler} is {@code null} * @see ReactiveX operators documentation: Sample */ @@ -12060,8 +11876,7 @@ public final Observable sample(@NonNull ObservableSource sampler) { * if {@code true} and the upstream completes while there is still an unsampled item available, * that item is emitted to downstream before completion * if {@code false}, an unsampled last item is ignored. - * @return an {@code Observable} that emits the results of sampling the items emitted by the current {@code Observable} whenever - * the {@code sampler} {@code ObservableSource} emits an item or completes + * @return the new {@code Observable} instance * @throws NullPointerException if {@code sampler} is {@code null} * @see ReactiveX operators documentation: Sample * @since 2.1 @@ -12092,7 +11907,7 @@ public final Observable sample(@NonNull ObservableSource sampler, bool * an accumulator function to be invoked on each item emitted by the current {@code Observable}, whose * result will be emitted to {@link Observer}s via {@link Observer#onNext onNext} and used in the * next accumulator call - * @return an {@code Observable} that emits the results of each call to the accumulator function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -12142,8 +11957,7 @@ public final Observable scan(@NonNull BiFunction accumulator) { * an accumulator function to be invoked on each item emitted by the current {@code Observable}, whose * result will be emitted to {@link Observer}s via {@link Observer#onNext onNext} and used in the * next accumulator call - * @return an {@code Observable} that emits {@code initialValue} followed by the results of each call to the - * accumulator function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code initialValue} or {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -12179,8 +11993,7 @@ public final Observable scan(@NonNull R initialValue, @NonNull BiFunction * an accumulator function to be invoked on each item emitted by the current {@code Observable}, whose * result will be emitted to {@code Observer}s via {@link Observer#onNext onNext} and used in the * next accumulator call - * @return an {@code Observable} that emits {@code initialValue} followed by the results of each call to the - * accumulator function + * @return the new {@code Observable} instance * @throws NullPointerException if {@code seedSupplier} or {@code accumulator} is {@code null} * @see ReactiveX operators documentation: Scan */ @@ -12209,8 +12022,7 @@ public final Observable scanWith(@NonNull Supplier seedSupplier, @NonN *
{@code serialize} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that is guaranteed to be well-behaved and to make only serialized calls to - * its observers + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Serialize */ @CheckReturnValue @@ -12233,8 +12045,7 @@ public final Observable serialize() { *
{@code share} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that upon connection causes the current {@code Observable} to emit items - * to its {@code Observer}s + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: RefCount */ @CheckReturnValue @@ -12255,7 +12066,7 @@ public final Observable share() { *
{@code singleElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Maybe} that emits the single item emitted by the current {@code Observable} + * @return the new {@code Maybe} instance * @see ReactiveX operators documentation: First */ @CheckReturnValue @@ -12324,8 +12135,7 @@ public final Single singleOrError() { * * @param count * the number of items to skip - * @return an {@code Observable} that is identical to the current {@code Observable} except that it does not emit the first - * {@code count} items that the current {@code Observable} emits + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count} is negative * @see ReactiveX operators documentation: Skip */ @@ -12357,8 +12167,7 @@ public final Observable skip(long count) { * the length of the time window to skip * @param unit * the time unit of {@code time} - * @return an {@code Observable} that skips values emitted by the current {@code Observable} before the time window defined - * by {@code time} elapses and the emits the remainder + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Skip */ @@ -12385,8 +12194,7 @@ public final Observable skip(long time, @NonNull TimeUnit unit) { * the time unit of {@code time} * @param scheduler * the {@code Scheduler} on which the timed wait happens - * @return an {@code Observable} that skips values emitted by the current {@code Observable} before the time window defined - * by {@code time} and {@code scheduler} elapses, and then emits the remainder + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Skip */ @@ -12413,8 +12221,7 @@ public final Observable skip(long time, @NonNull TimeUnit unit, @NonNull Sche * * @param count * number of items to drop from the end of the source sequence - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} except for the dropped ones - * at the end + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code count} is negative * @see ReactiveX operators documentation: SkipLast @@ -12449,8 +12256,7 @@ public final Observable skipLast(int count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return an {@code Observable} that drops those items emitted by the current {@code Observable} in a time window before the - * source completes defined by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -12481,8 +12287,7 @@ public final Observable skipLast(long time, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, an exception signaled by the current {@code Observable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return an {@code Observable} that drops those items emitted by the current {@code Observable} in a time window before the - * source completes defined by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -12511,8 +12316,7 @@ public final Observable skipLast(long time, @NonNull TimeUnit unit, boolean d * the time unit of {@code time} * @param scheduler * the scheduler used as the time source - * @return an {@code Observable} that drops those items emitted by the current {@code Observable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -12544,8 +12348,7 @@ public final Observable skipLast(long time, @NonNull TimeUnit unit, @NonNull * @param delayError * if {@code true}, an exception signaled by the current {@code Observable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return an {@code Observable} that drops those items emitted by the current {@code Observable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SkipLast */ @@ -12579,8 +12382,7 @@ public final Observable skipLast(long time, @NonNull TimeUnit unit, @NonNull * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be skipped - * @return an {@code Observable} that drops those items emitted by the current {@code Observable} in a time window before the - * source completes defined by {@code time} and {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: SkipLast @@ -12611,8 +12413,7 @@ public final Observable skipLast(long time, @NonNull TimeUnit unit, @NonNull * @param other * the second {@code ObservableSource} that has to emit an item before the current {@code Observable}'s elements begin * to be mirrored by the resulting {@code Observable} - * @return an {@code Observable} that skips items from the current {@code Observable} until the second {@code ObservableSource} emits an - * item, then emits the remaining items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: SkipUntil */ @@ -12636,8 +12437,7 @@ public final Observable skipUntil(@NonNull ObservableSource other) { * * @param predicate * a function to test each item emitted from the current {@code Observable} - * @return an {@code Observable} that begins emitting items emitted by the current {@code Observable} when the specified - * predicate becomes {@code false} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: SkipWhile */ @@ -12667,7 +12467,7 @@ public final Observable skipWhile(@NonNull Predicate predicate) { *
Scheduler:
*
{@code sorted} does not operate by default on a particular {@link Scheduler}.
* - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} in sorted order + * @return the new {@code Observable} instance */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -12692,7 +12492,7 @@ public final Observable sorted() { * a function that compares two items emitted by the current {@code Observable} and returns an {@code int} * that indicates their sort order * @throws NullPointerException if {@code sortFunction} is {@code null} - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} in sorted order + * @return the new {@code Observable} instance */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -12714,8 +12514,7 @@ public final Observable sorted(@NonNull Comparator sortFunction) { * * @param items * an {@code Iterable} that contains the items you want the resulting {@code Observable} to emit first - * @return an {@code Observable} that emits the items in the specified {@code Iterable} and then emits the items - * emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: StartWith * @since 3.0.0 @@ -12741,8 +12540,7 @@ public final Observable startWithIterable(@NonNull Iterable<@NonNull ? extend * * @param other * an {@code ObservableSource} that contains the items you want the modified {@code ObservableSource} to emit first - * @return an {@code Observable} that emits the items in the specified {@code ObservableSource} and then emits the items - * emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: StartWith */ @@ -12766,8 +12564,7 @@ public final Observable startWith(@NonNull ObservableSource othe * * @param item * the item to emit first - * @return an {@code Observable} that emits the specified item before it begins to emit items emitted by the current - * {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code item} is {@code null} * @see ReactiveX operators documentation: StartWith * @see #startWithArray(Object...) @@ -12793,8 +12590,7 @@ public final Observable startWithItem(@NonNull T item) { * * @param items * the array of values to emit first - * @return an {@code Observable} that emits the specified items before it begins to emit items emitted by the current - * {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code items} is {@code null} * @see ReactiveX operators documentation: StartWith * @see #startWithItem(Object) @@ -12823,8 +12619,7 @@ public final Observable startWithArray(@NonNull T... items) { *
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Observable} has finished sending them + * @return the new {@link Disposable} instance that can be used to dispose the subscription at any time * @see ReactiveX operators documentation: Subscribe */ @SchedulerSupport(SchedulerSupport.NONE) @@ -12846,8 +12641,7 @@ public final Disposable subscribe() { * * @param onNext * the {@code Consumer} you have designed to accept emissions from the current {@code Observable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Observable} has finished sending them + * @return the new {@link Disposable} instance that can be used to dispose the subscription at any time * @throws NullPointerException * if {@code onNext} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -12872,8 +12666,7 @@ public final Disposable subscribe(@NonNull Consumer onNext) { * @param onError * the {@code Consumer} you have designed to accept any error notification from the current * {@code Observable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Observable} has finished sending them + * @return the new {@link Disposable} instance that can be used to dispose the subscription at any time * @see ReactiveX operators documentation: Subscribe * @throws NullPointerException * if {@code onNext} or {@code onError} is {@code null} @@ -12901,8 +12694,7 @@ public final Disposable subscribe(@NonNull Consumer onNext, @NonNull * @param onComplete * the {@link Action} you have designed to accept a completion notification from the current * {@code Observable} - * @return a {@link Disposable} reference with which the caller can stop receiving items before - * the current {@code Observable} has finished sending them + * @return the new {@link Disposable} instance that can be used to dispose the subscription at any time * @throws NullPointerException * if {@code onNext}, {@code onError} or {@code onComplete} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -13000,8 +12792,7 @@ public final void subscribe(@NonNull Observer observer) { * * @param scheduler * the {@code Scheduler} to perform subscription actions on - * @return the current {@code Observable} modified so that its subscriptions happen on the - * specified {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: SubscribeOn * @see RxJava Threading Examples @@ -13027,8 +12818,7 @@ public final Observable subscribeOn(@NonNull Scheduler scheduler) { * * @param other * the alternate {@code ObservableSource} to subscribe to if the source does not emit any items - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} or the items of an - * alternate {@code ObservableSource} if the current {@code Observable} is empty. + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @since 1.1.0 */ @@ -13058,7 +12848,7 @@ public final Observable switchIfEmpty(@NonNull ObservableSource * @param mapper * a function that, when applied to an item emitted by the current {@code Observable}, returns an * {@code ObservableSource} - * @return an {@code Observable} that emits the items emitted by the {@code ObservableSource} returned from applying {@code mapper} to the most recently emitted item emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code mapper} is {@code null} * @see ReactiveX operators documentation: FlatMap * @see #switchMapDelayError(Function) @@ -13090,7 +12880,7 @@ public final Observable switchMap(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -13284,7 +13074,7 @@ public final Observable switchMapMaybeDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap * @see #switchMapSingleDelayError(Function) @@ -13317,8 +13107,7 @@ public final Observable switchMapSingle(@NonNull FunctionReactiveX operators documentation: FlatMap * @see #switchMapSingle(Function) @@ -13351,8 +13140,7 @@ public final Observable switchMapSingleDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap * @see #switchMap(Function) @@ -13386,7 +13174,7 @@ public final Observable switchMapDelayError(@NonNull FunctionReactiveX operators documentation: FlatMap @@ -13430,8 +13218,7 @@ public final Observable switchMapDelayError(@NonNull FunctionReactiveX operators documentation: Take */ @@ -13462,7 +13249,7 @@ public final Observable take(long count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return an {@code Observable} that emits those items emitted by the current {@code Observable} before the time runs out + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Take */ @@ -13492,8 +13279,7 @@ public final Observable take(long time, @NonNull TimeUnit unit) { * the time unit of {@code time} * @param scheduler * the {@code Scheduler} used for time source - * @return an {@code Observable} that emits those items emitted by the current {@code Observable} before the time runs out, - * according to the specified {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Take */ @@ -13517,7 +13303,7 @@ public final Observable take(long time, @NonNull TimeUnit unit, @NonNull Sche * @param count * the maximum number of items to emit from the end of the sequence of items emitted by the current * {@code Observable} - * @return an {@code Observable} that emits at most the last {@code count} items emitted by the current {@code Observable} + * @return the new {@code Observable} instance * @throws IllegalArgumentException * if {@code count} is negative * @see ReactiveX operators documentation: TakeLast @@ -13555,8 +13341,7 @@ public final Observable takeLast(int count) { * the length of the time window * @param unit * the time unit of {@code time} - * @return an {@code Observable} that emits at most {@code count} items from the current {@code Observable} that were emitted - * in a specified window of time before the current {@code Observable} completed + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is negative * @see ReactiveX operators documentation: TakeLast @@ -13587,9 +13372,7 @@ public final Observable takeLast(long count, long time, @NonNull TimeUnit uni * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that provides the timestamps for the observed items - * @return an {@code Observable} that emits at most {@code count} items from the current {@code Observable} that were emitted - * in a specified window of time before the current {@code Observable} completed, where the timing information is - * provided by the given {@code Scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code count} is negative @@ -13626,9 +13409,7 @@ public final Observable takeLast(long count, long time, @NonNull TimeUnit uni * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be last - * @return an {@code Observable} that emits at most {@code count} items from the current {@code Observable} that were emitted - * in a specified window of time before the current {@code Observable} completed, where the timing information is - * provided by the given {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException * if {@code count} is negative or {@code bufferSize} is non-positive @@ -13662,8 +13443,7 @@ public final Observable takeLast(long count, long time, @NonNull TimeUnit uni * the length of the time window * @param unit * the time unit of {@code time} - * @return an {@code Observable} that emits the items from the current {@code Observable} that were emitted in the window of - * time before the current {@code Observable} completed specified by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -13692,8 +13472,7 @@ public final Observable takeLast(long time, @NonNull TimeUnit unit) { * @param delayError * if {@code true}, an exception signaled by the current {@code Observable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return an {@code Observable} that emits the items from the current {@code Observable} that were emitted in the window of - * time before the current {@code Observable} completed specified by {@code time} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: TakeLast @@ -13722,9 +13501,7 @@ public final Observable takeLast(long time, @NonNull TimeUnit unit, boolean d * the time unit of {@code time} * @param scheduler * the {@code Scheduler} that provides the timestamps for the observed items - * @return an {@code Observable} that emits the items from the current {@code Observable} that were emitted in the window of - * time before the current {@code Observable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -13755,9 +13532,7 @@ public final Observable takeLast(long time, @NonNull TimeUnit unit, @NonNull * @param delayError * if {@code true}, an exception signaled by the current {@code Observable} is delayed until the regular elements are consumed * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped - * @return an {@code Observable} that emits the items from the current {@code Observable} that were emitted in the window of - * time before the current {@code Observable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TakeLast */ @@ -13790,9 +13565,7 @@ public final Observable takeLast(long time, @NonNull TimeUnit unit, @NonNull * by the downstream; if {@code false}, an exception is immediately signaled and all regular elements dropped * @param bufferSize * the hint about how many elements to expect to be last - * @return an {@code Observable} that emits the items from the current {@code Observable} that were emitted in the window of - * time before the current {@code Observable} completed specified by {@code time}, where the timing information is - * provided by {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: TakeLast @@ -13819,7 +13592,7 @@ public final Observable takeLast(long time, @NonNull TimeUnit unit, @NonNull * from the current {@code Observable} * @param * the type of items emitted by {@code other} - * @return an {@code Observable} that emits the items emitted by the current {@code Observable} until such time as {@code other} emits its first item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: TakeUntil */ @@ -13847,8 +13620,7 @@ public final Observable takeUntil(@NonNull ObservableSource other) { * * @param stopPredicate * a function that evaluates an item emitted by the current {@code Observable} and returns a {@link Boolean} - * @return an {@code Observable} that first emits items emitted by the current {@code Observable}, checks the specified - * condition after each item, and then completes when the condition is satisfied. + * @return the new {@code Observable} instance * @throws NullPointerException if {@code stopPredicate} is {@code null} * @see ReactiveX operators documentation: TakeUntil * @see Observable#takeWhile(Predicate) @@ -13874,8 +13646,7 @@ public final Observable takeUntil(@NonNull Predicate stopPredicate * * @param predicate * a function that evaluates an item emitted by the current {@code Observable} and returns a {@link Boolean} - * @return an {@code Observable} that emits the items from the current {@code Observable} so long as each item satisfies the - * condition defined by {@code predicate}, then completes + * @return the new {@code Observable} instance * @throws NullPointerException if {@code predicate} is {@code null} * @see ReactiveX operators documentation: TakeWhile * @see Observable#takeUntil(Predicate) @@ -13905,7 +13676,7 @@ public final Observable takeWhile(@NonNull Predicate predicate) { * time to wait before emitting another item after emitting the last item * @param unit * the unit of time of {@code windowDuration} - * @return an {@code Observable} that performs the throttle operation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample */ @@ -13936,7 +13707,7 @@ public final Observable throttleFirst(long windowDuration, @NonNull TimeUnit * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle timeout for each * event - * @return an {@code Observable} that performs the throttle operation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample */ @@ -13967,7 +13738,7 @@ public final Observable throttleFirst(long skipDuration, @NonNull TimeUnit un * emitted * @param unit * the unit of time of {@code intervalDuration} - * @return an {@code Observable} that performs the throttle operation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Sample * @see #sample(long, TimeUnit) @@ -14000,7 +13771,7 @@ public final Observable throttleLast(long intervalDuration, @NonNull TimeUnit * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle timeout for each * event - * @return an {@code Observable} that performs the throttle operation + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Sample * @see #sample(long, TimeUnit, Scheduler) @@ -14168,8 +13939,7 @@ public final Observable throttleLatest(long timeout, @NonNull TimeUnit unit, * resulting {@code Observable} * @param unit * the unit of time for the specified {@code timeout} - * @return an {@code Observable} that filters out items from the current {@code Observable} that are too quickly followed by - * newer items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Debounce * @see #debounce(long, TimeUnit) @@ -14204,8 +13974,7 @@ public final Observable throttleWithTimeout(long timeout, @NonNull TimeUnit u * @param scheduler * the {@code Scheduler} to use internally to manage the timers that handle the timeout for each * item - * @return an {@code Observable} that filters out items from the current {@code Observable} that are too quickly followed by - * newer items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Debounce * @see #debounce(long, TimeUnit, Scheduler) @@ -14228,7 +13997,7 @@ public final Observable throttleWithTimeout(long timeout, @NonNull TimeUnit u * from the {@code computation} {@link Scheduler}. * * - * @return an {@code Observable} that emits time interval information items + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: TimeInterval */ @CheckReturnValue @@ -14251,7 +14020,7 @@ public final Observable> timeInterval() { * * @param scheduler * the {@code Scheduler} used to compute time intervals - * @return an {@code Observable} that emits time interval information items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -14274,7 +14043,7 @@ public final Observable> timeInterval(@NonNull Scheduler scheduler) { * * * @param unit the time unit for the current time - * @return an {@code Observable} that emits time interval information items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -14299,7 +14068,7 @@ public final Observable> timeInterval(@NonNull TimeUnit unit) { * @param unit the time unit for the current time * @param scheduler * the {@code Scheduler} used to compute time intervals - * @return an {@code Observable} that emits time interval information items + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: TimeInterval */ @@ -14331,9 +14100,7 @@ public final Observable> timeInterval(@NonNull TimeUnit unit, @NonNull * @param itemTimeoutIndicator * a function that returns an {@code ObservableSource} for each item emitted by the current * {@code Observable} and that determines the timeout window for the subsequent item - * @return an {@code Observable} that mirrors the current {@code Observable}, but notifies observers of a - * {@code TimeoutException} if an item emitted by the current {@code Observable} takes longer to arrive than - * the time window defined by the selector for the previously emitted item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code itemTimeoutIndicator} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -14365,9 +14132,7 @@ public final Observable timeout(@NonNull FunctionReactiveX operators documentation: Timeout */ @@ -14395,8 +14160,7 @@ public final Observable timeout(@NonNull FunctionReactiveX operators documentation: Timeout */ @@ -14425,7 +14189,7 @@ public final Observable timeout(long timeout, @NonNull TimeUnit unit) { * the unit of time that applies to the {@code timeout} argument * @param other * the fallback {@code ObservableSource} to use in case of a timeout - * @return the current {@code Observable} modified to switch to the fallback {@code ObservableSource} in case of a timeout + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -14457,8 +14221,7 @@ public final Observable timeout(long timeout, @NonNull TimeUnit unit, @NonNul * the {@code Scheduler} to run the timeout timers on * @param other * the {@code ObservableSource} to use as the fallback in case of a timeout - * @return the current {@code Observable} modified so that it will switch to the fallback {@code ObservableSource} in case of a - * timeout + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -14488,8 +14251,7 @@ public final Observable timeout(long timeout, @NonNull TimeUnit unit, @NonNul * the unit of time that applies to the {@code timeout} argument * @param scheduler * the {@code Scheduler} to run the timeout timers on - * @return the current {@code Observable} modified to notify observers of a {@code TimeoutException} in case of a - * timeout + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -14522,9 +14284,7 @@ public final Observable timeout(long timeout, @NonNull TimeUnit unit, @NonNul * a function that returns an {@code ObservableSource} for each item emitted by the current {@code Observable} and that * determines the timeout window in which the subsequent source item must arrive in order to * continue the sequence - * @return an {@code Observable} that mirrors the current {@code Observable}, but notifies observers of a - * {@code TimeoutException} if either the first item or any subsequent item doesn't arrive within - * the time windows specified by the timeout selectors + * @return the new {@code Observable} instance * @throws NullPointerException if {@code firstTimeoutIndicator} or {@code itemTimeoutIndicator} is {@code null} * @see ReactiveX operators documentation: Timeout */ @@ -14561,9 +14321,7 @@ public final Observable timeout(@NonNull ObservableSource firstTime * continue the sequence * @param other * the fallback {@code ObservableSource} to switch to if the current {@code Observable} times out - * @return an {@code Observable} that mirrors the current {@code Observable}, but switches to the {@code other} {@code ObservableSource} if - * either the first item emitted by the current {@code Observable} or any subsequent item doesn't arrive - * within time windows defined by the timeout selectors + * @return the new {@code Observable} instance * @throws NullPointerException * if {@code firstTimeoutIndicator}, {@code itemTimeoutIndicator} or {@code other} is {@code null} * @see ReactiveX operators documentation: Timeout @@ -14609,7 +14367,7 @@ private Observable timeout0( * from the {@code computation} {@link Scheduler}. * * - * @return an {@code Observable} that emits timestamped items from the current {@code Observable} + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Timestamp */ @CheckReturnValue @@ -14632,8 +14390,7 @@ public final Observable> timestamp() { * * @param scheduler * the {@code Scheduler} to use as a time source - * @return an {@code Observable} that emits timestamped items from the current {@code Observable} with timestamps provided by - * the {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -14656,7 +14413,7 @@ public final Observable> timestamp(@NonNull Scheduler scheduler) { * * * @param unit the time unit for the current time - * @return an {@code Observable} that emits timestamped items from the current {@code Observable} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -14681,8 +14438,7 @@ public final Observable> timestamp(@NonNull TimeUnit unit) { * @param unit the time unit for the current time * @param scheduler * the {@code Scheduler} to use as a time source - * @return an {@code Observable} that emits timestamped items from the current {@code Observable} with timestamps provided by - * the {@code scheduler} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Timestamp */ @@ -14737,8 +14493,7 @@ public final R to(@NonNull ObservableConverter converter) { *
{@code toList} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Single} that emits a single item: a {@code List} containing all of the items emitted by the current - * {@code Observable} + * @return the new {@code Single} instance * @see ReactiveX operators documentation: To */ @CheckReturnValue @@ -14770,8 +14525,7 @@ public final R to(@NonNull ObservableConverter converter) { * * @param capacityHint * the number of elements expected from the current {@code Observable} - * @return a {@code Single} that emits a single item: a {@code List} containing all of the items emitted by the current - * {@code Observable} + * @return the new {@code Single} instance * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To */ @@ -14806,8 +14560,7 @@ public final R to(@NonNull ObservableConverter converter) { * @param the subclass of a collection of Ts * @param collectionSupplier * the {@link Supplier} returning the collection (for each individual {@code Observer}) to be filled in - * @return a {@code Single} that emits a single item: a {@code Collection} (subclass) containing all of the items emitted by the current - * {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code collectionSupplier} is {@code null} * @see ReactiveX operators documentation: To */ @@ -14839,8 +14592,7 @@ public final R to(@NonNull ObservableConverter converter) { * @param the key type of the Map * @param keySelector * the function that extracts the key from a source item to be used in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} containing the mapped items from the current - * {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -14875,8 +14627,7 @@ public final R to(@NonNull ObservableConverter converter) { * the function that extracts the key from a source item to be used in the {@code HashMap} * @param valueSelector * the function that extracts the value from a source item to be used in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} containing the mapped items from the current - * {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -14913,8 +14664,7 @@ public final Single> toMap( * the function that extracts the value from the source items to be used as value in the {@code Map} * @param mapSupplier * the function that returns a {@code Map} instance to be used - * @return a {@code Single} that emits a single item: a {@code Map} (subclass) that contains the mapped items emitted by the - * current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector}, {@code valueSelector} or {@code mapSupplier} is {@code null} * @see ReactiveX operators documentation: To */ @@ -14948,8 +14698,7 @@ public final Single> toMap( * @param the key type of the {@code HashMap} * @param keySelector * the function that extracts the key from the source items to be used as key in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} that contains an {@code ArrayList} of items mapped from - * the current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -14984,8 +14733,7 @@ public final Single> toMap( * the function that extracts a key from the source items to be used as key in the {@code HashMap} * @param valueSelector * the function that extracts a value from the source items to be used as value in the {@code HashMap} - * @return a {@code Single} that emits a single item: a {@code HashMap} that contains an {@code ArrayList} of items mapped from - * the current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector} or {@code valueSelector} is {@code null} * @see ReactiveX operators documentation: To */ @@ -15023,8 +14771,7 @@ public final Single> toMap( * the function that returns a {@code Map} instance to be used * @param collectionFactory * the function that returns a {@code Collection} instance for a particular key to be used in the {@code Map} - * @return a {@code Single} that emits a single item: a {@code Map} that contains the {@code Collection} of mapped items from - * the current {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector}, {@code valueSelector}, {@code mapSupplier} or {@code collectionFactory} is {@code null} * @see ReactiveX operators documentation: To */ @@ -15066,8 +14813,7 @@ public final Single> toMap( * the function that extracts a value from the source items to be used as the value in the {@code Map} * @param mapSupplier * the function that returns a {@code Map} instance to be used - * @return a {@code Single} that emits a single item: a {@code Map} that contains an {@code ArrayList} items mapped from the current - * {@code Observable} + * @return the new {@code Single} instance * @throws NullPointerException if {@code keySelector}, {@code valueSelector} or {@code mapSupplier} is {@code null} * @see ReactiveX operators documentation: To */ @@ -15159,8 +14905,7 @@ public final Flowable toFlowable(@NonNull BackpressureStrategy strategy) { *
Scheduler:
*
{@code toSortedList} does not operate by default on a particular {@link Scheduler}.
* - * @return a {@code Single} that emits a list that contains the items emitted by the current {@code Observable} in - * sorted order + * @return the new {@code Single} instance * @see ReactiveX operators documentation: To * @see #toSortedList(int) * @see #toSortedList(Comparator) @@ -15189,8 +14934,7 @@ public final Flowable toFlowable(@NonNull BackpressureStrategy strategy) { * @param comparator * a function that compares two items emitted by the current {@code Observable} and returns an {@code int} * that indicates their sort order - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Observable} in - * sorted order + * @return the new {@code Single} instance * @throws NullPointerException if {@code comparator} is {@code null} * @see ReactiveX operators documentation: To */ @@ -15221,8 +14965,7 @@ public final Flowable toFlowable(@NonNull BackpressureStrategy strategy) { * that indicates their sort order * @param capacityHint * the initial capacity of the {@code List} used to accumulate items before sorting - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Observable} in - * sorted order + * @return the new {@code Single} instance * @throws NullPointerException if {@code comparator} is {@code null} * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To @@ -15257,8 +15000,7 @@ public final Flowable toFlowable(@NonNull BackpressureStrategy strategy) { * * @param capacityHint * the initial capacity of the {@code List} used to accumulate items before sorting - * @return a {@code Single} that emits a {@code List} that contains the items emitted by the current {@code Observable} in - * sorted order + * @return the new {@code Single} instance * @throws IllegalArgumentException if {@code capacityHint} is non-positive * @see ReactiveX operators documentation: To * @since 2.0 @@ -15309,8 +15051,7 @@ public final Observable unsubscribeOn(@NonNull Scheduler scheduler) { * * @param count * the maximum size of each window before it should be emitted - * @return an {@code Observable} that emits connected, non-overlapping windows, each containing at most - * {@code count} items from the current {@code Observable} + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window */ @@ -15338,8 +15079,7 @@ public final Observable> window(long count) { * @param skip * how many items need to be skipped before starting a new window. Note that if {@code skip} and * {@code count} are equal this is the same operation as {@link #window(long)}. - * @return an {@code Observable} that emits windows every {@code skip} items containing at most {@code count} items - * from the current {@code Observable} + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count} or {@code skip} is non-positive * @see ReactiveX operators documentation: Window */ @@ -15369,8 +15109,7 @@ public final Observable> window(long count, long skip) { * {@code count} are equal this is the same operation as {@link #window(long)}. * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return an {@code Observable} that emits windows every {@code skip} items containing at most {@code count} items - * from the current {@code Observable} + * @return the new {@code Observable} instance * @throws IllegalArgumentException if {@code count}, {@code skip} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window */ @@ -15408,7 +15147,7 @@ public final Observable> window(long count, long skip, int bufferS * the period of time after which a new window will be created * @param unit * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments - * @return an {@code Observable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code timespan} or {@code timeskip} is non-positive * @see ReactiveX operators documentation: Window @@ -15446,7 +15185,7 @@ public final Observable> window(long timespan, long timeskip, @Non * the unit of time that applies to the {@code timespan} and {@code timeskip} arguments * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return an {@code Observable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code timespan} or {@code timeskip} is non-positive * @see ReactiveX operators documentation: Window @@ -15486,7 +15225,7 @@ public final Observable> window(long timespan, long timeskip, @Non * the {@code Scheduler} to use when determining the end and start of a window * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return an {@code Observable} that emits new windows periodically as a fixed timespan elapses + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code timespan}, {@code timeskip} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -15525,8 +15264,7 @@ public final Observable> window(long timespan, long timeskip, @Non * new window * @param unit * the unit of time that applies to the {@code timespan} argument - * @return an {@code Observable} that emits connected, non-overlapping windows representing items emitted by the - * current {@code Observable} during fixed, consecutive durations + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -15562,9 +15300,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * the unit of time that applies to the {@code timespan} argument * @param count * the maximum size of each window before it should be emitted - * @return an {@code Observable} that emits connected, non-overlapping windows of items from the current {@code Observable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -15604,9 +15340,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * the maximum size of each window before it should be emitted * @param restart * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well - * @return an {@code Observable} that emits connected, non-overlapping windows of items from the current {@code Observable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -15643,8 +15377,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * the unit of time which applies to the {@code timespan} argument * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return an {@code Observable} that emits connected, non-overlapping windows containing items emitted by the - * current {@code Observable} within a fixed duration + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -15683,9 +15416,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * the maximum size of each window before it should be emitted * @param scheduler * the {@code Scheduler} to use when determining the end and start of a window - * @return an {@code Observable} that emits connected, non-overlapping windows of items from the current {@code Observable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -15727,9 +15458,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * the {@code Scheduler} to use when determining the end and start of a window * @param restart * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well - * @return an {@code Observable} that emits connected, non-overlapping windows of items from the current {@code Observable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} is non-positive * @see ReactiveX operators documentation: Window @@ -15773,9 +15502,7 @@ public final Observable> window(long timespan, @NonNull TimeUnit u * if {@code true}, when a window reaches the capacity limit, the timer is restarted as well * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return an {@code Observable} that emits connected, non-overlapping windows of items from the current {@code Observable} - * that were emitted during a fixed duration of time or when the window has reached maximum capacity - * (whichever occurs first) + * @return the new {@code Observable} instance * @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null} * @throws IllegalArgumentException if {@code count} or {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -15813,9 +15540,7 @@ public final Observable> window( * the window element type (ignored) * @param boundary * an {@code ObservableSource} whose emitted items close and open windows - * @return an {@code Observable} that emits non-overlapping windows of items it collects from the current {@code Observable} - * where the boundary of each window is determined by the items emitted from the {@code boundary} - * {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code boundary} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -15848,9 +15573,7 @@ public final Observable> window(@NonNull ObservableSource b * an {@code ObservableSource} whose emitted items close and open windows * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return an {@code Observable} that emits non-overlapping windows of items it collects from the current {@code Observable} - * where the boundary of each window is determined by the items emitted from the {@code boundary} - * {@code ObservableSource} + * @return the new {@code Observable} instance * @throws NullPointerException if {@code boundary} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -15888,8 +15611,7 @@ public final Observable> window(@NonNull ObservableSource b * @param closingIndicator * a {@link Function} that produces an {@code ObservableSource} for every window created. When this indicator {@code ObservableSource} * emits an item, the associated window is completed - * @return an {@code Observable} that emits windows of items emitted by the current {@code Observable} that are governed by - * the specified window-governing {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @see ReactiveX operators documentation: Window */ @@ -15928,8 +15650,7 @@ public final Observable> window( * emits an item, the associated window is completed * @param bufferSize * the capacity hint for the buffer in the inner windows - * @return an {@code Observable} that emits windows of items emitted by the current {@code Observable} that are governed by - * the specified window-governing {@code ObservableSource}s + * @return the new {@code Observable} instance * @throws NullPointerException if {@code openingIndicator} or {@code closingIndicator} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive * @see ReactiveX operators documentation: Window @@ -15964,9 +15685,7 @@ public final Observable> window( * @param combiner * the function to call when the current {@code Observable} emits an item and the other {@code ObservableSource} has already * emitted an item, to generate the item to be emitted by the resulting {@code Observable} - * @return an {@code Observable} that merges the specified {@code ObservableSource} into the current {@code Observable} by using the - * {@code resultSelector} function only when the current {@code Observable} sequence (this instance) emits an - * item + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} or {@code combiner} is {@code null} * @since 2.0 * @see ReactiveX operators documentation: CombineLatest @@ -16191,8 +15910,7 @@ public final Observable withLatestFrom(@NonNull Iterable<@NonNull ? exten * @param zipper * a function that combines the pairs of items from the current {@code Observable} and the {@code Iterable} to generate * the items to be emitted by the resulting {@code Observable} - * @return an {@code Observable} that pairs up values from the current {@code Observable} and the {@code other} {@code Iterable} - * sequence and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -16236,8 +15954,7 @@ public final Observable withLatestFrom(@NonNull Iterable<@NonNull ? exten * @param zipper * a function that combines the pairs of items from the current {@code Observable} and the other {@code ObservableSource} to generate the items to * be emitted by the resulting {@code Observable} - * @return an {@code Observable} that pairs up values from the current {@code Observable} and the {@code other} {@code ObservableSource} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip */ @@ -16283,8 +16000,7 @@ public final Observable zipWith(@NonNull ObservableSource * be emitted by the resulting {@code Observable} * @param delayError * if {@code true}, errors from the current {@code Observable} or the other {@code ObservableSource} is delayed until both terminate - * @return an {@code Observable} that pairs up values from the current {@code Observable} and the {@code other} {@code ObservableSource} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Observable} instance * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @see ReactiveX operators documentation: Zip * @since 2.0 @@ -16332,8 +16048,7 @@ public final Observable zipWith(@NonNull ObservableSource * the capacity hint for the buffer in the inner windows * @param delayError * if {@code true}, errors from the current {@code Observable} or the other {@code ObservableSource} is delayed until both terminate - * @return an {@code Observable} that pairs up values from the current {@code Observable} and the {@code other} {@code ObservableSource} - * and emits the results of {@code zipFunction} applied to these pairs + * @return the new {@code Observable} instance * @see ReactiveX operators documentation: Zip * @throws NullPointerException if {@code other} or {@code zipper} is {@code null} * @throws IllegalArgumentException if {@code bufferSize} is non-positive diff --git a/src/main/java/io/reactivex/rxjava3/core/Single.java b/src/main/java/io/reactivex/rxjava3/core/Single.java index 4b22be8dcf..eb90b83fcb 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Single.java +++ b/src/main/java/io/reactivex/rxjava3/core/Single.java @@ -294,7 +294,7 @@ public static Flowable concat(@NonNull Publisher<@NonNull ? extends Singl * a {@code SingleSource} to be concatenated * @param source2 * a {@code SingleSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the two source {@code SingleSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1} or {@code source2} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -328,7 +328,7 @@ public static Flowable concat( * a {@code SingleSource} to be concatenated * @param source3 * a {@code SingleSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the three source {@code SingleSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2} or {@code source3} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -366,7 +366,7 @@ public static Flowable concat( * a {@code SingleSource} to be concatenated * @param source4 * a {@code SingleSource} to be concatenated - * @return a {@code Flowable} that emits items emitted by the four source {@code SingleSource}s, one after the other. + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code source1}, {@code source2}, {@code source3} or {@code source4} is {@code null} * @see ReactiveX operators documentation: Concat */ @@ -1517,7 +1517,7 @@ public static Single using( * * @param the value type * @param source the source to wrap - * @return the {@code Single} wrapper or the source cast to {@code Single} (if possible) + * @return the new {@code Single} instance * @throws NullPointerException if {@code source} is {@code null} */ @CheckReturnValue @@ -2101,7 +2101,7 @@ public final Single hide() { * * @param the value type of the single returned by the transformer function * @param transformer the transformer function, not {@code null} - * @return a {@code Single} wrapped and returned by the transformer function + * @return the new {@code Single} instance * @throws NullPointerException if {@code transformer} is {@code null} * @see RxJava wiki: Implementing Your Own Operators */ @@ -3206,7 +3206,7 @@ public final Single contains(@NonNull Object value, @NonNull BiPredicat * * @param other * a {@code SingleSource} to be merged - * @return that emits all of the items emitted by the current {@code Single}s + * @return the new {@code Flowable} instance * @throws NullPointerException if {@code other} is {@code null} * @see ReactiveX operators documentation: Merge */ @@ -3665,7 +3665,7 @@ public final Single retryWhen(@NonNull Function, *
{@code subscribe} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@link Disposable} reference can request the {@link Single} stop work. + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @see ReactiveX operators documentation: Subscribe */ @SchedulerSupport(SchedulerSupport.NONE) @@ -3687,7 +3687,7 @@ public final Disposable subscribe() { * @param onCallback * the callback that receives either the success value or the failure {@link Throwable} * (whichever is not {@code null}) - * @return a {@link Disposable} reference can request the {@link Single} stop work. + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @see ReactiveX operators documentation: Subscribe * @throws NullPointerException * if {@code onCallback} is {@code null} @@ -3718,7 +3718,7 @@ public final Disposable subscribe(@NonNull BiConsumer} you have designed to accept the emission from the {@code Single} - * @return a {@link Disposable} reference can request the {@link Single} stop work. + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @throws NullPointerException * if {@code onSuccess} is {@code null} * @see ReactiveX operators documentation: Subscribe @@ -3745,7 +3745,7 @@ public final Disposable subscribe(@NonNull Consumer onSuccess) { * @param onError * the {@code Consumer} you have designed to accept any error notification from the * {@code Single} - * @return a {@link Disposable} reference can request the {@link Single} stop work. + * @return the new {@link Disposable} instance that can be used for disposing the subscription at any time * @see ReactiveX operators documentation: Subscribe * @throws NullPointerException * if {@code onSuccess} or {@code onError} is {@code null} @@ -4074,8 +4074,7 @@ public final R to(@NonNull SingleConverter converter) { *
{@code ignoreElement} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Completable} that signals {@code onComplete} on it's observer when the current {@code Single} - * calls {@code onSuccess}. + * @return the new {@code Completable} instance * @since 2.1.13 */ @CheckReturnValue @@ -4096,7 +4095,7 @@ public final Completable ignoreElement() { *
{@code toFlowable} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Flowable} that emits a single item T or an error. + * @return the new {@code Flowable} instance */ @BackpressureSupport(BackpressureKind.FULL) @CheckReturnValue @@ -4119,7 +4118,7 @@ public final Flowable toFlowable() { *
{@code toFuture} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Future} that expects a single item to be emitted by this {@code Single} + * @return the new {@code Future} instance * @see ReactiveX documentation: To */ @CheckReturnValue @@ -4138,7 +4137,7 @@ public final Future toFuture() { *
{@code toMaybe} does not operate by default on a particular {@link Scheduler}.
* * - * @return a {@code Maybe} that emits a single item or an error. + * @return the new {@code Maybe} instance */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -4159,7 +4158,7 @@ public final Maybe toMaybe() { *
{@code toObservable} does not operate by default on a particular {@link Scheduler}.
* * - * @return an {@code Observable} that emits a single item or an error. + * @return the new {@code Observable} instance */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) diff --git a/src/main/java/io/reactivex/rxjava3/parallel/ParallelFlowable.java b/src/main/java/io/reactivex/rxjava3/parallel/ParallelFlowable.java index 0fb07bac37..403f69b1a0 100644 --- a/src/main/java/io/reactivex/rxjava3/parallel/ParallelFlowable.java +++ b/src/main/java/io/reactivex/rxjava3/parallel/ParallelFlowable.java @@ -103,7 +103,7 @@ protected final boolean validate(@NonNull Subscriber<@NonNull ?>[] subscribers) * * @param the value type * @param source the source {@code Publisher} - * @return the {@code ParallelFlowable} instance + * @return the new {@code ParallelFlowable} instance * @throws NullPointerException if {@code source} is {@code null} */ @CheckReturnValue @@ -1140,7 +1140,7 @@ public final ParallelFlowable compose(@NonNull ParallelTransformer * requests {@link Flowable#bufferSize()} amount from each rail upfront * and keeps requesting as many items per rail as many inner sources on * that rail completed. The inner sources are requested {@link Flowable#bufferSize()} - * amount upfront, then 75% of this amount requested after 75% received. + * amount upfront, then 75% of this amount requested after 75% received. *
Scheduler:
*
{@code flatMap} does not operate by default on a particular {@link Scheduler}.
* diff --git a/src/test/java/io/reactivex/rxjava3/internal/util/OperatorMatrixGenerator.java b/src/test/java/io/reactivex/rxjava3/internal/util/OperatorMatrixGenerator.java index 1528568e7e..42ea23dd1d 100644 --- a/src/test/java/io/reactivex/rxjava3/internal/util/OperatorMatrixGenerator.java +++ b/src/test/java/io/reactivex/rxjava3/internal/util/OperatorMatrixGenerator.java @@ -45,7 +45,7 @@ public static void main(String[] args) throws IOException { Map, Set> operatorMap = new HashMap<>(); for (Class clazz : CLASSES) { - Set set = operatorMap.computeIfAbsent(clazz, c -> new HashSet()); + Set set = operatorMap.computeIfAbsent(clazz, c -> new HashSet<>()); for (Method m : clazz.getMethods()) { String name = m.getName(); diff --git a/src/test/java/io/reactivex/rxjava3/validators/JavadocWording.java b/src/test/java/io/reactivex/rxjava3/validators/JavadocWording.java index a20245d10b..d351e7809d 100644 --- a/src/test/java/io/reactivex/rxjava3/validators/JavadocWording.java +++ b/src/test/java/io/reactivex/rxjava3/validators/JavadocWording.java @@ -207,8 +207,11 @@ public void maybeDocRefersToMaybeTypes() throws Exception { break; } } + + checkAtReturnAndSignatureMatch("Maybe", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); + aOrAn(e, m, "Maybe"); - missingClosingDD(e, m, "Maybe"); + missingClosingDD(e, m, "Maybe", "io.reactivex.rxjava3.core"); backpressureMentionedWithoutAnnotation(e, m, "Maybe"); } } @@ -347,10 +350,10 @@ public void flowableDocRefersToFlowableTypes() throws Exception { } } - checkAtReturnAndSignatureMatch("Flowable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable"); + checkAtReturnAndSignatureMatch("Flowable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "ConnectableFlowable", "ParallelFlowable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); aOrAn(e, m, "Flowable"); - missingClosingDD(e, m, "Flowable"); + missingClosingDD(e, m, "Flowable", "io.reactivex.rxjava3.core"); backpressureMentionedWithoutAnnotation(e, m, "Flowable"); } } @@ -362,6 +365,148 @@ public void flowableDocRefersToFlowableTypes() throws Exception { } } + @Test + public void parallelFlowableDocRefersToCorrectTypes() throws Exception { + List list = BaseTypeParser.parse(TestHelper.findSource("ParallelFlowable", "io.reactivex.rxjava3.parallel"), "ParallelFlowable"); + + assertFalse(list.isEmpty()); + + StringBuilder e = new StringBuilder(); + + for (RxMethod m : list) { + int jdx; + if (m.javadoc != null) { + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf("onSuccess", jdx); + if (idx >= 0) { + if (!m.signature.contains("Maybe") + && !m.signature.contains("MaybeSource") + && !m.signature.contains("Single") + && !m.signature.contains("SingleSource")) { + e.append("java.lang.RuntimeException: Flowable doc mentions onSuccess\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf(" Observer", jdx); + if (idx >= 0) { + if (!m.signature.contains("ObservableSource") + && !m.signature.contains("Observable")) { + e.append("java.lang.RuntimeException: Flowable doc mentions Observer but not using Observable\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf(" SingleObserver", jdx); + if (idx >= 0) { + if (!m.signature.contains("SingleSource") + && !m.signature.contains("Single")) { + e.append("java.lang.RuntimeException: Flowable doc mentions SingleObserver but not using Single\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf(" MaybeObserver", jdx); + if (idx >= 0) { + if (!m.signature.contains("MaybeSource") + && !m.signature.contains("Maybe")) { + e.append("java.lang.RuntimeException: Flowable doc mentions MaybeObserver but not using Maybe\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf(" Disposable", jdx); + if (idx >= 0) { + if (!m.signature.contains("Observable") + && !m.signature.contains("ObservableSource") + && !m.signature.contains("Single") + && !m.signature.contains("SingleSource") + && !m.signature.contains("Completable") + && !m.signature.contains("CompletableSource") + && !m.signature.contains("Maybe") + && !m.signature.contains("MaybeSource") + && !m.signature.contains("Disposable") + ) { + CharSequence subSequence = m.javadoc.subSequence(idx - 6, idx + 11); + if (idx < 6 || !subSequence.equals("{@link Disposable")) { + e.append("java.lang.RuntimeException: Flowable doc mentions Disposable but not using Flowable\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf("Observable", jdx); + if (idx >= 0) { + if (!m.signature.contains("Observable")) { + e.append("java.lang.RuntimeException: Flowable doc mentions Observable but not in the signature\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + + jdx = idx + 6; + } else { + break; + } + } + jdx = 0; + for (;;) { + int idx = m.javadoc.indexOf("ObservableSource", jdx); + if (idx >= 0) { + if (!m.signature.contains("ObservableSource")) { + e.append("java.lang.RuntimeException: Flowable doc mentions ObservableSource but not in the signature\r\n at io.reactivex.rxjava3.core.") + .append("Flowable.method(Flowable.java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n"); + } + jdx = idx + 6; + } else { + break; + } + } + + checkAtReturnAndSignatureMatch("ParallelFlowable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "ConnectableFlowable", "ParallelFlowable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); + + aOrAn(e, m, "ParallelFlowable"); + missingClosingDD(e, m, "ParallelFlowable", "io.reactivex.rxjava3.parallel"); + backpressureMentionedWithoutAnnotation(e, m, "ParallelFlowable"); + } + } + + if (e.length() != 0) { + System.out.println(e); + + fail(e.toString()); + } + } + @Test public void observableDocRefersToObservableTypes() throws Exception { List list = BaseTypeParser.parse(TestHelper.findSource("Observable"), "Observable"); @@ -450,10 +595,10 @@ public void observableDocRefersToObservableTypes() throws Exception { break; } } - checkAtReturnAndSignatureMatch("Observable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable"); + checkAtReturnAndSignatureMatch("Observable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "ConnectableObservable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); aOrAn(e, m, "Observable"); - missingClosingDD(e, m, "Observable"); + missingClosingDD(e, m, "Observable", "io.reactivex.rxjava3.core"); backpressureMentionedWithoutAnnotation(e, m, "Observable"); } } @@ -626,8 +771,10 @@ public void singleDocRefersToSingleTypes() throws Exception { } } + checkAtReturnAndSignatureMatch("Single", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); + aOrAn(e, m, "Single"); - missingClosingDD(e, m, "Single"); + missingClosingDD(e, m, "Single", "io.reactivex.rxjava3.core"); backpressureMentionedWithoutAnnotation(e, m, "Single"); } } @@ -815,10 +962,10 @@ public void completableDocRefersToCompletableTypes() throws Exception { } } - checkAtReturnAndSignatureMatch("Completable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable"); + checkAtReturnAndSignatureMatch("Completable", m, e, "Flowable", "Observable", "Maybe", "Single", "Completable", "Disposable", "Iterable", "Stream", "Future", "CompletionStage"); aOrAn(e, m, "Completable"); - missingClosingDD(e, m, "Completable"); + missingClosingDD(e, m, "Completable", "io.reactivex.rxjava3.core"); backpressureMentionedWithoutAnnotation(e, m, "Completable"); } } @@ -983,7 +1130,7 @@ static void aOrAn(StringBuilder e, RxMethod m, String wrongPre, String word, Str } } - static void missingClosingDD(StringBuilder e, RxMethod m, String baseTypeName) { + static void missingClosingDD(StringBuilder e, RxMethod m, String baseTypeName, String packageName) { int jdx = 0; for (;;) { int idx1 = m.javadoc.indexOf("
", jdx); @@ -999,7 +1146,9 @@ static void missingClosingDD(StringBuilder e, RxMethod m, String baseTypeName) { jdx = idx2 + 5; } else { e.append("java.lang.RuntimeException: unbalanced
") - .append("\r\n at io.reactivex.rxjava3.core.") + .append("\r\n at ") + .append(packageName) + .append(".") .append(baseTypeName) .append(".method(") .append(baseTypeName)