* * {@code Single} behaves similarly to {@link Observable} except that it can only emit either a single successful - * value or an error (there is no "onComplete" notification as there is for an {@link Observable}). + * value or an error (there is no {@code onComplete} notification as there is for an {@code Observable}). *
* The {@code Single} class implements the {@link SingleSource} base interface and the default consumer * type it interacts with is the {@link SingleObserver} via the {@link #subscribe(SingleObserver)} method. @@ -68,7 +67,7 @@ *
*
*
- * See {@link Flowable} or {@link Observable} for the + * See {@link Flowable} or {@code Observable} for the * implementation of the Reactive Pattern for a stream or vector of values. *
* For more information see the ReactiveX
@@ -110,14 +109,14 @@
* allow working with a {@code SingleObserver} (or subclass) instance to be applied with in
* a fluent manner (such as in the example above).
* @param
*
*
*
*
*
*
* Eager concatenation means that once a subscriber subscribes, this operator subscribes to all of the
- * source SingleSources. The operator buffers the value emitted by these SingleSources and then drains them
- * in order, each one after the previous one completes.
+ * source {@code SingleSource}s. The operator buffers the value emitted by these {@code SingleSource}s and then drains them
+ * in order, each one after the previous one succeeds.
*
* Eager concatenation means that once a subscriber subscribes, this operator subscribes to all of the
- * emitted source Publishers as they are observed. The operator buffers the values emitted by these
- * Publishers and then drains them in order, each one after the previous one completes.
+ * emitted source {@code SingleSource}s as they are observed. The operator buffers the values emitted by these
+ * {@code SingleSource}s and then drains them in order, each one after the previous one succeeds.
*
* Eager concatenation means that once a subscriber subscribes, this operator subscribes to all of the
- * source SingleSources. The operator buffers the values emitted by these SingleSources and then drains them
- * in order, each one after the previous one completes.
+ * source {@code SingleSource}s. The operator buffers the values emitted by these {@code SingleSource}s and then drains them
+ * in order, each one after the previous one succeeds.
*
@@ -512,15 +518,16 @@ public static
*
- * Allows you to defer execution of passed function until SingleObserver subscribes to the {@link Single}.
+ * Allows you to defer execution of passed function until {@code SingleObserver} subscribes to the {@code Single}.
* It makes passed function "lazy".
* Result of the function invocation will be emitted by the {@link Single}.
*
@@ -613,7 +624,7 @@ public static
*
- * You can convert any object that supports the {@link Future} interface into a Single that emits the return
- * value of the {@link Future#get} method of that object, by passing the object into the {@code from}
- * method.
+ * The operator calls {@link Future#get()}, which is a blocking method, on the subscription thread.
+ * It is recommended applying {@link #subscribeOn(Scheduler)} to move this blocking wait to a
+ * background thread, and if the {@link Scheduler} supports it, interrupt the wait when the flow
+ * is disposed.
*
- * Important note: This Single is blocking; you cannot dispose it.
+ * A non-{@code null} value is then emitted via {@code onSuccess} or any exception is emitted via
+ * {@code onError}. If the {@code Future} completes with {@code null}, a {@link NullPointerException}
+ * is signaled.
*
*
- * You can convert any object that supports the {@link Future} interface into a {@code Single} that emits
- * the return value of the {@link Future#get} method of that object, by passing the object into the
- * {@code from} method.
*
- * Important note: This {@code Single} is blocking; you cannot dispose it.
+ * The operator calls {@link Future#get(long, TimeUnit)}, which is a blocking method, on the subscription thread.
+ * It is recommended applying {@link #subscribeOn(Scheduler)} to move this blocking wait to a
+ * background thread, and if the {@link Scheduler} supports it, interrupt the wait when the flow
+ * is disposed.
+ *
+ * A non-{@code null} value is then emitted via {@code onSuccess} or any exception is emitted via
+ * {@code onError}. If the {@code Future} completes with {@code null}, a {@link NullPointerException}
+ * is signaled.
*
*
- * You can convert any object that supports the {@link Future} interface into a {@code Single} that emits
+ * You can convert any object that supports the {@code Future} interface into a {@code Single} that emits
* the return value of the {@link Future#get} method of that object, by passing the object into the
* {@code from} method.
*
@@ -717,17 +738,17 @@ public static
*
- * You can convert any object that supports the {@link Future} interface into a {@code Single} that emits
+ * You can convert any object that supports the {@code Future} interface into a {@code Single} that emits
* the return value of the {@link Future#get} method of that object, by passing the object into the
* {@code from} method.
* If the source Publisher is empty, a NoSuchElementException is signalled. If
- * the source has more than one element, an IndexOutOfBoundsException is signalled.
+ * Wraps a specific {@link Publisher} into a {@code Single} and signals its single element or error.
+ *
+ *
- * The {@link Publisher} must follow the
- * Reactive-Streams specification.
+ * If the source {@code Publisher} is empty, a {@link NoSuchElementException} is signaled. If
+ * the source has more than one element, an {@link IndexOutOfBoundsException} is signaled.
+ *
+ * The {@code Publisher} must follow the
+ * Reactive Streams specification.
* Violating the specification may result in undefined behavior.
*
* If possible, use {@link #create(SingleOnSubscribe)} to create a
* source-like {@code Single} instead.
*
- * Note that even though {@link Publisher} appears to be a functional interface, it
+ * Note that even though {@code Publisher} appears to be a functional interface, it
* is not recommended to implement it through a lambda as the specification requires
* state management that is not achievable with a stateless lambda.
- *
- * If the ObservableSource is empty, a NoSuchElementException is signalled.
- * If the source has more than one element, an IndexOutOfBoundsException is signalled.
+ * Wraps a specific {@link ObservableSource} into a {@code Single} and signals its single element or error.
*
*
+ * If the {@code ObservableSource} is empty, a {@link NoSuchElementException} is signaled.
+ * If the source has more than one element, an {@link IndexOutOfBoundsException} is signaled.
*
@@ -852,10 +877,11 @@ public static
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as a single {@code Flowable}, by
* using the {@code merge} method.
*
*
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by using
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as a single {@code Flowable}, by
* the {@code merge} method.
*
*
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by using
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as a single {@code Flowable}, by
* the {@code merge} method.
*
* History: 2.1.9 - experimental
* @param History: 2.1.9 - experimental
* @param
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as one {@code Flowable}, by
* using the {@code mergeDelayError} method.
*
*
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by using
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as one {@code Flowable}, by
* the {@code mergeDelayError} method.
* History: 2.1.9 - experimental
* @param
*
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by using
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as one {@code Flowable}, by
* the {@code mergeDelayError} method.
* History: 2.1.9 - experimental
* @param
*
*
*
*
*
*
*
*
- * If the {@code Iterable} of {@link SingleSource}s is empty a {@link NoSuchElementException} error is signalled after subscription.
+ * If the {@code Iterable} of {@code SingleSource}s is empty a {@link NoSuchElementException} error is signaled after subscription.
*
* Note on method signature: since Java doesn't allow creating a generic array with {@code new T[]}, the
* implementation of this operator has to create an {@code Object[]} instead. Unfortunately, a
- * {@code Function
*
- * If any of the SingleSources signal an error, all other SingleSources get disposed and the
+ * If any of the {@code SingleSources} signal an error, all other {@code SingleSource}s get disposed and the
* error emitted to downstream immediately.
*
*
*
*
*
*
*
*
*
*
- * If the array of {@link SingleSource}s is empty a {@link NoSuchElementException} error is signalled immediately.
+ * If the array of {@code SingleSource}s is empty a {@link NoSuchElementException} error is signaled immediately.
*
* Note on method signature: since Java doesn't allow creating a generic array with {@code new T[]}, the
* implementation of this operator has to create an {@code Object[]} instead. Unfortunately, a
- * {@code Function
- * If any of the SingleSources signal an error, all other SingleSources get disposed and the
+ * If any of the {@code SingleSource}s signal an error, all other {@code SingleSource}s get disposed and the
* error emitted to downstream immediately.
*
*
*
- * This method operates on the Single itself whereas {@link #lift} operates on the Single's SingleObservers.
+ * This method operates on the {@code Single} itself whereas {@link #lift} operates on {@link SingleObserver}s.
*
- * If the operator you are creating is designed to act on the individual item emitted by a Single, use
- * {@link #lift}. If your operator is designed to transform the source Single as a whole (for instance, by
+ * If the operator you are creating is designed to act on the individual item emitted by a {@code Single}, use
+ * {@link #lift}. If your operator is designed to transform the source {@code Single} as a whole (for instance, by
* applying a particular set of existing RxJava operators to it) use {@code compose}.
*
- * The returned Single subscribes to the current Single when the first SingleObserver subscribes.
+ * The returned {@code Single} subscribes to the current {@code Single} when the first {@code SingleObserver} subscribes.
*
*
*
*
* History: 2.1.5 - experimental
* @param time the amount of time the success or error signal should be delayed for
* @param unit the time unit
- * @param delayError if true, both success and error signals are delayed. if false, only success signals are delayed.
- * @return the new Single instance
+ * @param delayError if {@code true}, both success and error signals are delayed. if {@code false}, only success signals are delayed.
+ * @return the new {@code Single} instance
* @since 2.2
*/
@CheckReturnValue
@@ -2223,7 +2288,7 @@ public final Single
*
*
* If the delaying source signals an error, that error is re-emitted and no subscription
- * to the current Single happens.
+ * to the current {@code Single} happens.
*
* If the delaying source signals an error, that error is re-emitted and no subscription
- * to the current Single happens.
+ * to the current {@code Single} happens.
*
* If the delaying source signals an error, that error is re-emitted and no subscription
- * to the current Single happens.
+ * to the current {@code Single} happens.
*
* If the delaying source signals an error, that error is re-emitted and no subscription
- * to the current Single happens.
+ * to the current {@code Single} happens.
* The other source is consumed in an unbounded manner (requesting {@link Long#MAX_VALUE} from it).
*
*
*
@@ -2450,8 +2521,9 @@ public final Single History: 2.2.4 - experimental
* @param History: 2.0.1 - experimental
- * @param onAfterSuccess the Consumer that will be called after emitting an item from upstream to the downstream
- * @return the new Single instance
+ * @param onAfterSuccess the {@link Consumer} that will be called after emitting an item from upstream to the downstream
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code onAfterSuccess} is {@code null}
* @since 2.1
*/
@CheckReturnValue
@@ -2488,7 +2561,7 @@ public final Single
*
@@ -2502,9 +2575,10 @@ public final Single History: 2.0.6 - experimental
* @param onAfterTerminate
- * an {@link Action} to be invoked when the source Single finishes
- * @return a Single that emits the same items as the source Single, then invokes the
- * {@link Action}
+ * an {@code Action} to be invoked when the source {@code Single} finishes
+ * @return the new {@code Single} that emits the same items as the source {@code Single}, then invokes the
+ * {@code Action}
+ * @throws NullPointerException if {@code onAfterTerminate} is {@code null}
* @see ReactiveX operators documentation: Do
* @since 2.1
*/
@@ -2517,7 +2591,7 @@ public final Single In case of a race between a terminal event and a dispose call, the provided {@code onFinally} action
* is executed once per subscription.
@@ -2531,8 +2605,9 @@ public final Single History: 2.0.1 - experimental
- * @param onFinally the action called when this Single terminates or gets disposed
- * @return the new Single instance
+ * @param onFinally the action called when this {@code Single} terminates or gets disposed
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code onFinally} is {@code null}
* @since 2.1
*/
@CheckReturnValue
@@ -2544,8 +2619,8 @@ public final Single
*
*
@@ -2579,7 +2655,8 @@ public final Single History: 2.2.7 - experimental
* @param onTerminate the action to invoke when the consumer calls {@code onSuccess} or {@code onError}
- * @return the new Single instance
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code onTerminate} is {@code null}
* @see ReactiveX operators documentation: Do
* @see #doOnTerminate(Action)
* @since 3.0.0
@@ -2593,8 +2670,8 @@ public final Single
*
*
*
*
*
* Note also that it is not possible to stop the subscription phase in {@code lift()} as the {@code apply()} method
- * requires a non-null {@code SingleObserver} instance to be returned, which is then unconditionally subscribed to
+ * requires a non-{@code null} {@code SingleObserver} instance to be returned, which is then unconditionally subscribed to
* the upstream {@code Single}. For example, if the operator decided there is no reason to subscribe to the
* upstream source because of some optimization possibility or a failure to prepare the operator, it still has to
- * return a {@code SingleObserver} that should immediately dispose the upstream's {@code Disposable} in its
+ * return a {@code SingleObserver} that should immediately dispose the upstream's {@link Disposable} in its
* {@code onSubscribe} method. Again, using a {@code SingleTransformer} and extending the {@code Single} is
* a better option as {@link #subscribeActual} can decide to not subscribe to its upstream after all.
*
*
* History: 2.2.4 - experimental
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 3.0.0
* @see #dematerialize(Function)
*/
@@ -3109,7 +3199,7 @@ public final Single
*
*
*
- * You can combine items emitted by multiple Singles so that they appear as a single Flowable, by using
+ * You can combine items emitted by multiple {@code SingleSource}s so that they appear as one {@code Flowable}, by using
* the {@code mergeWith} method.
*
*
*
- * By default, when a Single encounters an error that prevents it from emitting the expected item to its
- * subscriber, the Single invokes its subscriber's {@link SingleObserver#onError} method, and then quits
- * without invoking any more of its subscriber's methods. The {@code onErrorReturn} method changes this
- * behavior. If you pass a function ({@code resumeFunction}) to a Single's {@code onErrorReturn} method, if
- * the original Single encounters an error, instead of invoking its subscriber's
+ * By default, when a {@code Single} encounters an error that prevents it from emitting the expected item to its
+ * subscriber, the {@code Single} invokes its subscriber's {@link SingleObserver#onError} method, and then quits
+ * without invoking any more of its observer's methods. The {@code onErrorReturn} method changes this
+ * behavior. If you pass a function ({@code resumeFunction}) to a {@code Single}'s {@code onErrorReturn} method, if
+ * the original {@code Single} encounters an error, instead of invoking its observer's
* {@link SingleObserver#onError} method, it will instead emit the return value of {@code resumeFunction}.
*
* You can use this to prevent errors from propagating or to supply fallback data should errors be
@@ -3229,9 +3321,10 @@ public final Single
*
*
- * By default, when a Single encounters an error that prevents it from emitting the expected item to
- * its {@link SingleObserver}, the Single invokes its SingleObserver's {@code onError} method, and then quits
- * without invoking any more of its SingleObserver's methods. The {@code onErrorResumeWith} method changes this
- * behavior. If you pass another Single ({@code resumeSingleInCaseOfError}) to a Single's
- * {@code onErrorResumeWith} method, if the original Single encounters an error, instead of invoking its
- * SingleObserver's {@code onError} method, it will instead relinquish control to {@code resumeSingleInCaseOfError} which
- * will invoke the SingleObserver's {@link SingleObserver#onSuccess onSuccess} method if it is able to do so. In such a case,
- * because no Single necessarily invokes {@code onError}, the SingleObserver may never know that an error
+ * By default, when a {@code Single} encounters an error that prevents it from emitting the expected item to
+ * its {@link SingleObserver}, the {@code Single} invokes its {@code SingleObserver}'s {@code onError} method, and then quits
+ * without invoking any more of its {@code SingleObserver}'s methods. The {@code onErrorResumeWith} method changes this
+ * behavior. If you pass another {@code Single} ({@code resumeSingleInCaseOfError}) to a {@code Single}'s
+ * {@code onErrorResumeWith} method, if the original {@code Single} encounters an error, instead of invoking its
+ * {@code SingleObserver}'s {@code onError} method, it will instead relinquish control to {@code resumeSingleInCaseOfError} which
+ * will invoke the {@code SingleObserver}'s {@link SingleObserver#onSuccess onSuccess} method if it is able to do so. In such a case,
+ * because no {@code Single} necessarily invokes {@code onError}, the {@code SingleObserver} may never know that an error
* happened.
*
* You can use this to prevent errors from propagating or to supply fallback data should errors be
@@ -3285,32 +3379,33 @@ public final Single
*
- * By default, when a Single encounters an error that prevents it from emitting the expected item to
- * its {@link SingleObserver}, the Single invokes its SingleObserver's {@code onError} method, and then quits
- * without invoking any more of its SingleObserver's methods. The {@code onErrorResumeNext} method changes this
- * behavior. If you pass a function that will return another Single ({@code resumeFunctionInCaseOfError}) to a Single's
- * {@code onErrorResumeNext} method, if the original Single encounters an error, instead of invoking its
- * SingleObserver's {@code onError} method, it will instead relinquish control to {@code resumeSingleInCaseOfError} which
- * will invoke the SingleObserver's {@link SingleObserver#onSuccess onSuccess} method if it is able to do so. In such a case,
- * because no Single necessarily invokes {@code onError}, the SingleObserver may never know that an error
+ * By default, when a {@code Single} encounters an error that prevents it from emitting the expected item to
+ * its {@link SingleObserver}, the {@code Single} invokes its {@code SingleObserver}'s {@code onError} method, and then quits
+ * without invoking any more of its {@code SingleObserver}'s methods. The {@code onErrorResumeNext} method changes this
+ * behavior. If you pass a function that will return another {@code Single} ({@code resumeFunctionInCaseOfError}) to a {@code Single}'s
+ * {@code onErrorResumeNext} method, if the original {@code Single} encounters an error, instead of invoking its
+ * {@code SingleObserver}'s {@code onError} method, it will instead relinquish control to {@code resumeSingleInCaseOfError} which
+ * will invoke the {@code SingleObserver}'s {@link SingleObserver#onSuccess onSuccess} method if it is able to do so. In such a case,
+ * because no {@code Single} necessarily invokes {@code onError}, the {@code SingleObserver} may never know that an error
* happened.
*
* You can use this to prevent errors from propagating or to supply fallback data should errors be
@@ -3320,8 +3415,9 @@ public final Single
* History: 2.1.5 - experimental
- * @return a Single which nulls out references to the upstream producer and downstream SingleObserver if
- * the sequence is terminated or downstream calls dispose()
+ * @return the new {@code Single} which {@code null}s out references to the upstream producer and downstream {@code SingleObserver} if
+ * the sequence is terminated or downstream calls {@code dispose()}
* @since 2.2
*/
@CheckReturnValue
@@ -3356,7 +3452,7 @@ public final Single
*
*
*
*
*
*
* History: 2.1.8 - experimental
- * @param times the number of times to resubscribe if the current Single fails
- * @param predicate the predicate called with the failure Throwable
- * and should return true if a resubscription should happen
- * @return the new Single instance
+ * @param times the number of times to resubscribe if the current {@code Single} fails
+ * @param predicate the predicate called with the failure {@link Throwable}
+ * and should return {@code true} if a resubscription should happen
+ * @return the new {@code Single} instance
* @since 2.2
*/
@CheckReturnValue
@@ -3532,17 +3629,17 @@ public final Single
*
*
- * If the Publisher signals an {@code onComplete}, the resulting {@code Single} will signal a {@link NoSuchElementException}.
+ * If the {@code Publisher} signals an {@code onComplete}, the resulting {@code Single} will signal a {@link NoSuchElementException}.
*
* Note that the inner {@code Publisher} returned by the handler function should signal
* either {@code onNext}, {@code onError} or {@code onComplete} in response to the received
- * {@code Throwable} to indicate the operator should retry or terminate. If the upstream to
- * the operator is asynchronous, signaling onNext followed by onComplete immediately may
+ * {@link Throwable} to indicate the operator should retry or terminate. If the upstream to
+ * the operator is asynchronous, signaling {@code onNext} followed by {@code onComplete} immediately may
* result in the sequence to be completed immediately. Similarly, if this inner
* {@code Publisher} signals {@code onError} or {@code onComplete} while the upstream is
* active, the sequence is terminated with the same signal immediately.
@@ -3589,11 +3686,11 @@ public final Single
*
- * If the Single emits an error, it is wrapped into an
+ * If the {@code Single} emits an error, it is wrapped into an
* {@link io.reactivex.rxjava3.exceptions.OnErrorNotImplementedException OnErrorNotImplementedException}
- * and routed to the RxJavaPlugins.onError handler.
+ * and routed to the {@link RxJavaPlugins#onError(Throwable)} handler.
*
*
- * If the Single emits an error, it is wrapped into an
+ * If the {@code Single} emits an error, it is wrapped into an
* {@link io.reactivex.rxjava3.exceptions.OnErrorNotImplementedException OnErrorNotImplementedException}
- * and routed to the RxJavaPlugins.onError handler.
+ * and routed to the {@link RxJavaPlugins#onError(Throwable)} handler.
*
* There is no need to call any of the plugin hooks on the current {@code Single} instance or
* the {@code SingleObserver}; all hooks and basic safeguards have been
* applied by {@link #subscribe(SingleObserver)} before this method gets called.
- * @param observer the SingleObserver to handle, not null
+ * @param observer the {@code SingleObserver} to handle, not {@code null}
*/
protected abstract void subscribeActual(@NonNull SingleObserver observer);
/**
- * Subscribes a given SingleObserver (subclass) to this Single and returns the given
- * SingleObserver as is.
+ * Subscribes a given {@link SingleObserver} (subclass) to this {@code Single} and returns the given
+ * {@code SingleObserver} as is.
*
* Usage example:
@@ -3763,10 +3859,10 @@ public final void subscribe(@NonNull SingleObserver observer) {
*
*
@@ -3813,9 +3910,10 @@ public final Single
@@ -3841,12 +3939,13 @@ public final Single
@@ -3870,10 +3969,12 @@ public final
*
*
*
* History: 2.1.7 - experimental
* @param
*
*
*
*
* History: 2.0.9 - experimental
* @param scheduler the target scheduler where to execute the disposal
- * @return the new Single instance
- * @throws NullPointerException if scheduler is null
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code scheduler} is {@code null}
* @since 2.2
*/
@CheckReturnValue
@@ -4141,8 +4241,8 @@ public final Single
*
*
*
*
- * The operator closes the {@code Stream} upon cancellation and when it terminates. Exceptions raised when
+ * The operator closes the {@code Stream} upon cancellation and when it terminates. The exceptions raised when
* closing a {@code Stream} are routed to the global error handler ({@link RxJavaPlugins#onError(Throwable)}.
* If a {@code Stream} should not be closed, turn it into an {@link Iterable} and use {@link #flattenAsFlowable(Function)}:
*
- * The operator closes the {@code Stream} upon cancellation and when it terminates. Exceptions raised when
+ * The operator closes the {@code Stream} upon cancellation and when it terminates. The exceptions raised when
* closing a {@code Stream} are routed to the global error handler ({@link RxJavaPlugins#onError(Throwable)}.
* If a {@code Stream} should not be closed, turn it into an {@link Iterable} and use {@link #flattenAsFlowable(Function)}:
* 
@@ -126,9 +125,10 @@ public abstract class Single
@@ -151,7 +151,7 @@ public static 
*
*
* @param 
*
@@ -204,8 +204,9 @@ public static
* @param 
*
*
* @param 
*
*
* @param 
*
@@ -284,10 +287,11 @@ public static
*
* @param callable
- * function which execution should be deferred, it will be invoked when SingleObserver will subscribe to the {@link Single}.
+ * function which execution should be deferred, it will be invoked when {@code SingleObserver} will subscribe to the {@link Single}.
* @param 
*
@@ -315,12 +319,13 @@ public static
*
* @param exception
- * the particular Throwable to pass to {@link SingleObserver#onError onError}
+ * the particular {@link Throwable} to pass to {@link SingleObserver#onError onError}
* @param 
*
@@ -350,14 +355,15 @@ public static
* @param 
*
*
* @param 
*
*
* @param 
*
*
* @param 
*
*
* @param 
* 
*
@@ -563,9 +571,10 @@ public static
* @param 
@@ -586,11 +595,12 @@ public static 
*
*
*
* @param future
- * the source {@link Future}
+ * the source {@code Future}
* @param
*
*
*
* @param future
- * the source {@link Future}
+ * the source {@code Future}
* @param timeout
* the maximum time to wait before calling {@code get}
* @param unit
* the {@link TimeUnit} of the {@code timeout} argument
* @param
* 
*
*
*
* @param future
- * the source {@link Future}
+ * the source {@code Future}
* @param scheduler
- * the {@link Scheduler} to wait for the Future on. Use a Scheduler such as
- * {@link Schedulers#io()} that can block and wait on the Future
+ * the {@code Scheduler} to wait for the {@code Future} on. Use a {@code Scheduler} such as
+ * {@link Schedulers#io()} that can block and wait on the {@code Future}
* @param 
*
*
*
* @param 
+ *
*
*
- * @param observableSource the source Observable, not null
+ * @param observableSource the source sequence to wrap, not {@code null}
* @param 
*
@@ -906,13 +933,13 @@ public static
* @param 
*
@@ -944,13 +972,13 @@ public static
* @param 
*
*
* 
*
*
- * @param onSubscribe the consumer called with the Disposable sent via onSubscribe
- * @return the new Single instance
+ * @param onSubscribe the consumer called with the {@code Disposable} sent via {@code onSubscribe}
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code onSubscribe} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2566,8 +2642,8 @@ public final Single
*
*
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -2082,14 +2143,14 @@ public final Single
*
*
*
- * @param 
*
@@ -1171,8 +1204,9 @@ public static
* 
*
@@ -1197,10 +1231,11 @@ public static
*
*
*
*
* @param 
*
*
- * @param 
*
@@ -1355,7 +1393,7 @@ public static
- * @param 
*
@@ -1364,7 +1402,7 @@ public static
* @param delay the delay amount
* @param unit the time unit of the delay
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -1375,20 +1413,21 @@ public static Single
*
*
* @param delay the delay amount
* @param unit the time unit of the delay
- * @param scheduler the scheduler where the single 0L will be emitted
- * @return the new Single instance
+ * @param scheduler the {@code Scheduler} where the single 0L will be emitted
+ * @return the new {@code Single} instance
* @throws NullPointerException
- * if unit is null, or
- * if scheduler is null
+ * if {@code unit} is {@code null}, or
+ * if {@code scheduler} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -1401,7 +1440,7 @@ public static Single
*
@@ -1409,9 +1448,10 @@ public static Single
* @param 
*
@@ -1433,8 +1473,9 @@ public static
* @param 
@@ -1460,16 +1501,16 @@ public static 
@@ -1490,21 +1531,22 @@ public static 
@@ -1533,7 +1575,8 @@ public static 
*
*
* @param 
*
@@ -1594,17 +1639,18 @@ public static
*
@@ -1630,20 +1676,21 @@ public static
*
- * @param
*
@@ -1671,23 +1718,24 @@ public static
*
- * @param
*
@@ -1716,26 +1764,28 @@ public static
*
- * @param
*
@@ -1766,29 +1816,31 @@ public static
*
- * @param
*
@@ -1820,32 +1872,34 @@ public static
*
- * @param
*
@@ -1879,35 +1933,37 @@ public static
*
- * @param
*
@@ -1942,38 +1998,41 @@ public static
*
- * @param 
*
*
* @param 
*
*
- * @param other the other SingleSource to race for the first emission of success or error
- * @return the new Single instance. A subscription to this provided source will occur after subscribing
+ * @param other the other {@code SingleSource} to race for the first emission of success or error
+ * @return the new {@code Single} instance. A subscription to this provided source will occur after subscribing
* to the current source.
+ * @throws NullPointerException if {@code other} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2063,7 +2124,7 @@ public final Single
@@ -2071,7 +2132,7 @@ public final Single
*
*
*
* @param 
*
*
*
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -2131,8 +2193,8 @@ public final Single
*
@@ -2140,8 +2202,9 @@ public final Single
* @param the target type
- * @param clazz the type token to use for casting the success result from the current Single
- * @return the new Single instance
+ * @param clazz the type token to use for casting the success result from the current {@code Single}
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code clazz} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2153,8 +2216,8 @@ public final Single cast(@NonNull Class clazz) {
}
/**
- * Returns a Flowable that emits the item emitted by the source Single, then the item emitted by the
- * specified Single.
+ * Returns a {@link Flowable} that emits the item emitted by the source {@code Single}, then the item emitted by the
+ * specified {@link SingleSource}.
* 
*
@@ -2165,9 +2228,10 @@ public final Single cast(@NonNull Class clazz) {
*
*
* @param other
- * a Single to be concatenated after the current
- * @return a Flowable that emits the item emitted by the source Single, followed by the item emitted by
- * {@code t1}
+ * a {@code SingleSource} to be concatenated after the current
+ * @return the new {@code Flowable} that emits the item emitted by the source {@code Single}, followed by the item emitted by
+ * {@code other}
+ * @throws NullPointerException if {@code other} is {@code null}
* @see ReactiveX operators documentation: Concat
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -2179,7 +2243,7 @@ public final Flowable
@@ -2190,8 +2254,9 @@ public final Flowable
*
@@ -2211,8 +2276,8 @@ public final Single
* 
@@ -2235,11 +2300,12 @@ public final Single
*
@@ -2260,11 +2326,11 @@ public final Single
* 
*
*
- * @param other the CompletableSource that has to complete before the subscription to the
- * current Single happens
- * @return the new Single instance
+ * @param other the {@code CompletableSource} that has to complete before the subscription to the
+ * current {@code Single} happens
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code other} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2301,20 +2368,21 @@ public final Single
*
*
* @param the element type of the other source
- * @param other the SingleSource that has to complete before the subscription to the
- * current Single happens
- * @return the new Single instance
+ * @param other the {@code SingleSource} that has to complete before the subscription to the
+ * current {@code Single} happens
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code other} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2326,20 +2394,21 @@ public final Single
*
*
* @param the element type of the other source
- * @param other the ObservableSource that has to signal a value or complete before the
- * subscription to the current Single happens
- * @return the new Single instance
+ * @param other the {@code ObservableSource} that has to signal a value or complete before the
+ * subscription to the current {@code Single} happens
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code other} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2351,12 +2420,12 @@ public final Single
*
*
* @param the element type of the other source
- * @param other the Publisher that has to signal a value or complete before the
- * subscription to the current Single happens
- * @return the new Single instance
+ * @param other the {@code Publisher} that has to signal a value or complete before the
+ * subscription to the current {@code Single} happens
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code other} is {@code null}
* @since 2.0
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -2381,17 +2451,18 @@ public final Single
*
*
* @param time the time amount to wait with the subscription
* @param unit the time unit of the waiting
- * @return the new Single instance
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code unit} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2402,18 +2473,18 @@ public final Single
*
*
* @param time the time amount to wait with the subscription
* @param unit the time unit of the waiting
- * @param scheduler the scheduler to wait on and subscribe on to the current Single
- * @return the new Single instance
+ * @param scheduler the {@code Scheduler} to wait on and subscribe on to the current {@code Single}
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -2424,7 +2495,7 @@ public final Single
* 
* 
* 
* 
*
@@ -2624,7 +2702,8 @@ public final Single
* @param onEvent the consumer called with the success value of onEvent
- * @return the new Single instance
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code onEvent} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -2636,8 +2715,8 @@ public final Single
* 
* 
*
@@ -2691,10 +2771,11 @@ public final Single
*
* @param predicate
- * a function that evaluates the item emitted by the source Maybe, returning {@code true}
+ * a function that evaluates the item emitted by the source {@code Single}, returning {@code true}
* if it passes the filter
- * @return a Maybe that emit the item emitted by the source Maybe that the filter
+ * @return the new {@link Maybe} that emit the item emitted by the source {@code Single} that the filter
* evaluates as {@code true}
+ * @throws NullPointerException if {@code predicate} is {@code null}
* @see ReactiveX operators documentation: Filter
*/
@CheckReturnValue
@@ -2706,8 +2787,8 @@ public final Maybe
*
@@ -2717,8 +2798,9 @@ public final Maybe
*
- * @param resumeFunctionInCaseOfError a function that returns a Single that will take control if source Single encounters an error.
- * @return the original Single, with appropriately modified behavior.
+ * @param fallback a function that returns a {@code Single} that will take control if source {@code Single} encounters an error.
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code fallback} is {@code null}
* @see ReactiveX operators documentation: Catch
* @since .20
*/
@@ -3329,14 +3425,14 @@ public final Single
*
@@ -2741,8 +2823,9 @@ public final
*
- * @param resumeSingleInCaseOfError a Single that will take control if source Single encounters an error.
- * @return the original Single, with appropriately modified behavior.
+ * @param fallback a {@code Single} that will take control if source {@code Single} encounters an error.
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code fallback} is {@code null}
* @see ReactiveX operators documentation: Catch
*/
@CheckReturnValue
@NonNull
@SchedulerSupport(SchedulerSupport.NONE)
- public final Single
*
@@ -2768,9 +2851,10 @@ public final
*
* @param resumeFunction
- * a function that returns an item that the new Single will emit if the source Single encounters
+ * a function that returns an item that the new {@code Single} will emit if the source {@code Single} encounters
* an error
- * @return the original Single with appropriately modified behavior
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code resumeFunction} is {@code null}
* @see ReactiveX operators documentation: Catch
*/
@CheckReturnValue
@@ -3243,15 +3336,16 @@ public final Single
@@ -2795,11 +2879,12 @@ public final 
@@ -2823,11 +2908,12 @@ public final Flowable flattenAsFlowable(@NonNull Function
*
* @param
- * the type of item emitted by the resulting Iterable
+ * the type of item emitted by the resulting {@code Iterable}
* @param mapper
- * a function that returns an Iterable sequence of values for when given an item emitted by the
- * source Single
- * @return the new Observable instance
+ * a function that returns an {@code Iterable} sequence of values for when given an item emitted by the
+ * source {@code Single}
+ * @return the new {@code Observable} instance
+ * @throws NullPointerException if {@code mapper} is {@code null}
* @see ReactiveX operators documentation: FlatMap
* @see #flattenStreamAsObservable(Function)
*/
@@ -2840,8 +2926,8 @@ public final Flowable flattenAsFlowable(@NonNull Function
* 
*
@@ -2851,8 +2937,9 @@ public final Flowable flattenAsFlowable(@NonNull Function the result value type
* @param mapper
- * a function that, when applied to the item emitted by the source Single, returns an ObservableSource
- * @return the Observable returned from {@code func} when applied to the item emitted by the source Single
+ * a function that, when applied to the item emitted by the source {@code Single}, returns an {@code ObservableSource}
+ * @return the new {@code Observable} instance
+ * @throws NullPointerException if {@code mapper} is {@code null}
* @see ReactiveX operators documentation: FlatMap
*/
@CheckReturnValue
@@ -2865,7 +2952,7 @@ public final Flowable flattenAsFlowable(@NonNull Function
*
- * @param value the value to compare against the success value of this Single
- * @return the new Single instance
+ * @param value the value to compare against the success value of this {@code Single}
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3131,18 +3221,19 @@ public final Single
*
@@ -2874,9 +2961,10 @@ public final Flowable flattenAsFlowable(@NonNull Function
*
* @param mapper
- * a function that, when applied to the item emitted by the source Single, returns a
- * Completable
- * @return the Completable returned from {@code func} when applied to the item emitted by the source Single
+ * a function that, when applied to the item emitted by the source {@code Single}, returns a
+ * {@code CompletableSource}
+ * @return the new {@code Completable} instance
+ * @throws NullPointerException if {@code mapper} is {@code null}
* @see ReactiveX operators documentation: FlatMap
* @since 2.0
*/
@@ -2889,7 +2977,7 @@ public final Completable flatMapCompletable(@NonNull Function
*
* 
@@ -3035,23 +3123,24 @@ public final T blockingGet() {
* class and creating a {@link SingleTransformer} with it is recommended.
*
*
*
* @param 
@@ -3075,8 +3164,9 @@ public final 
@@ -3097,7 +3187,7 @@ public final 
@@ -3119,8 +3209,8 @@ public final Single
*
*
- * @param value the value to compare against the success value of this Single
- * @param comparer the function that receives the success value of this Single, the value provided
- * and should return true if they are considered equal
- * @return the new Single instance
+ * @param value the value to compare against the success value of this {@code Single}
+ * @param comparer the function that receives the success value of this {@code Single}, the value provided
+ * and should return {@code true} if they are considered equal
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code value} or {@code comparer} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -3155,11 +3246,11 @@ public final Single
*
*
*
* @param other
- * a SingleSource to be merged
- * @return that emits all of the items emitted by the source Singles
+ * a {@code SingleSource} to be merged
+ * @return that emits all of the items emitted by the source {@code Single}s
+ * @throws NullPointerException if {@code other} is {@code null}
* @see ReactiveX operators documentation: Merge
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -3182,20 +3274,20 @@ public final Flowable
*
*
*
* @param scheduler
- * the {@link Scheduler} to notify subscribers on
- * @return the source Single modified so that its subscribers are notified on the specified
- * {@link Scheduler}
- * @throws NullPointerException if scheduler is null
+ * the {@code Scheduler} to notify subscribers on
+ * @return the source {@code Single} modified so that its subscribers are notified on the specified
+ * {@code Scheduler}
+ * @throws NullPointerException if {@code scheduler} is {@code null}
* @see ReactiveX operators documentation: ObserveOn
* @see RxJava Threading Examples
* @see #subscribeOn
@@ -3209,16 +3301,16 @@ public final Single
* 
*
*
- * @param value the value to signal if the current Single fails
- * @return the new Single instance
+ * @param value the value to signal if the current {@code Single} fails
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code value} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@@ -3263,19 +3357,19 @@ public final Single
* 
* 
*
@@ -3344,8 +3440,8 @@ public final Single
* 
*
@@ -3365,7 +3461,7 @@ public final Single
- * @return the new Flowable instance
+ * @return the new {@code Flowable} instance
* @since 2.0
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -3377,7 +3473,7 @@ public final Flowable
*
@@ -3386,8 +3482,8 @@ public final Flowable
- * @param times the number of times to re-subscribe to the current Single
- * @return the new Flowable instance
+ * @param times the number of times to re-subscribe to the current {@code Single}
+ * @return the new {@code Flowable} instance
* @since 2.0
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -3399,9 +3495,9 @@ public final Flowable
*
@@ -3411,11 +3507,11 @@ public final Flowable
- * @param handler the function that is called with a Flowable that signals a value when the Single
- * signalled a success value and returns a Publisher that has to signal a value to
- * trigger a resubscription to the current Single, otherwise the terminal signal of
- * the Publisher will be the terminal signal of the sequence as well.
- * @return the new Flowable instance
+ * @param handler the function that is called with a {@code Flowable} that signals a value when the {@code Single}
+ * signaled a success value and returns a {@code Publisher} that has to signal a value to
+ * trigger a resubscription to the current {@code Single}, otherwise the terminal signal of
+ * the {@code Publisher} will be the terminal signal of the sequence as well.
+ * @return the new {@code Flowable} instance
* @since 2.0
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -3427,7 +3523,8 @@ public final Flowable
*
@@ -3436,9 +3533,9 @@ public final Flowable
- * @param stop the BooleanSupplier called after the current Single succeeds and if returns false,
- * the Single is re-subscribed; otherwise the sequence completes.
- * @return the new Flowable instance
+ * @param stop the {@code BooleanSupplier} called after the current {@code Single} succeeds and if returns {@code false},
+ * the {@code Single} is re-subscribed; otherwise the sequence completes.
+ * @return the new {@code Flowable} instance
* @since 2.0
*/
@BackpressureSupport(BackpressureKind.FULL)
@@ -3450,14 +3547,14 @@ public final Flowable
*
*
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3468,16 +3565,16 @@ public final Single
*
*
- * @param times the number of times to resubscribe if the current Single fails
- * @return the new Single instance
+ * @param times the number of times to resubscribe if the current {@code Single} fails
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3488,17 +3585,17 @@ public final Single
*
*
- * @param predicate the predicate called with the resubscription count and the failure Throwable
- * and should return true if a resubscription should happen
- * @return the new Single instance
+ * @param predicate the predicate called with the resubscription count and the failure {@link Throwable}
+ * and should return {@code true} if a resubscription should happen
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3509,8 +3606,8 @@ public final Single
*
@@ -3518,10 +3615,10 @@ public final Single
* 
*
*
- * @param predicate the predicate called with the failure Throwable
- * and should return true if a resubscription should happen
- * @return the new Single instance
+ * @param predicate the predicate called with the failure {@link Throwable}
+ * and should return {@code true} if a resubscription should happen
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3553,17 +3650,17 @@ public final Single
* 
*
*
*
* @param onCallback
- * the callback that receives either the success value or the failure Throwable
- * (whichever is not null)
+ * 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.
* @see ReactiveX operators documentation: Subscribe
* @throws NullPointerException
- * if {@code onCallback} is null
+ * if {@code onCallback} is {@code null}
*/
@CheckReturnValue
@NonNull
@@ -3654,23 +3751,23 @@ public final Disposable subscribe(@NonNull BiConsumer
* 
@@ -3635,12 +3732,12 @@ public final Disposable subscribe() {
* 
*
*
*
* @param onSuccess
- * the {@code Consumer
@@ -3691,15 +3788,14 @@ public final Disposable subscribe(@NonNull Consumer onSuccess) {
*
*
* @param onSuccess
- * the {@code Consumer
* 
*
*
*
* @param scheduler
- * the {@link Scheduler} to perform subscription actions on
- * @return the source Single modified so that its subscriptions happen on the specified {@link Scheduler}
+ * the {@code Scheduler} to perform subscription actions on
+ * @return the source {@code Single} modified so that its subscriptions happen on the specified {@code Scheduler}
+ * @throws NullPointerException if {@code scheduler} is {@code null}
* @see ReactiveX operators documentation: SubscribeOn
* @see RxJava Threading Examples
* @see #observeOn
@@ -3802,7 +3899,7 @@ public final Single
*
*
* @param timeout the timeout amount
* @param unit the time unit
- * @return the new Single instance
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3906,19 +4007,19 @@ public final Single
*
*
* @param timeout the timeout amount
* @param unit the time unit
- * @param scheduler the target scheduler where the timeout is awaited and the TimeoutException
- * signalled
- * @return the new Single instance
+ * @param scheduler the target {@code Scheduler} where the timeout is awaited and the {@code TimeoutException}
+ * signaled
+ * @return the new {@code Single} instance
* @since 2.0
*/
@CheckReturnValue
@@ -3929,61 +4030,60 @@ public final Single
*
*
* @param timeout the timeout amount
* @param unit the time unit
- * @param scheduler the scheduler where the timeout is awaited and the subscription to other happens
- * @param other the other SingleSource that gets subscribed to if the current Single times out
- * @return the new Single instance
+ * @param scheduler the {@code Scheduler} where the timeout is awaited and the subscription to other happens
+ * @param fallback the other {@code SingleSource} that gets subscribed to if the current {@code Single} times out
+ * @return the new {@code Single} instance
+ * @throws NullPointerException if {@code unit}, {@code scheduler} or {@code fallback} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@NonNull
@SchedulerSupport(SchedulerSupport.CUSTOM)
- public final Single
*
*
* @param timeout the timeout amount
* @param unit the time unit
- * @param other the other SingleSource that gets subscribed to if the current Single times out
- * @return the new Single instance
+ * @param fallback the other {@code SingleSource} that gets subscribed to if the current {@code Single} times out
+ * @return the new {@code Single} instance
* @throws NullPointerException
- * if other is null, or
- * if unit is null, or
- * if scheduler is null
+ * if {@code fallback} or {@code unit} is {@code null}
* @since 2.0
*/
@CheckReturnValue
@NonNull
@SchedulerSupport(SchedulerSupport.COMPUTATION)
- public final Single
@@ -4019,7 +4119,7 @@ public final 
*
@@ -4041,7 +4141,7 @@ public final Completable ignoreElement() {
*
*
- * @return a {@link Flowable} that emits a single item T or an error.
+ * @return a {@lcode Flowable} that emits a single item T or an error.
*/
@BackpressureSupport(BackpressureKind.FULL)
@CheckReturnValue
@@ -4064,7 +4164,7 @@ public final Flowable
*
@@ -4083,7 +4183,7 @@ public final Future
*
- * @return a {@link Maybe} that emits a single item T or an error.
+ * @return a {@code Maybe} that emits a single item or an error.
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
@@ -4096,7 +4196,7 @@ public final Maybe
*
@@ -4104,7 +4204,7 @@ public final Maybe
*
- * @return an {@link Observable} that emits a single item T or an error.
+ * @return an {@code Observable} that emits a single item or an error.
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
@@ -4118,18 +4218,18 @@ public final Observable
*
*
* 
*
@@ -4151,15 +4251,15 @@ public final Single
*
* @param
- * the type of items emitted by the {@code other} Single
+ * the type of items emitted by the {@code other} {@code Single}
* @param 
*
*
- * @return the new TestObserver instance
+ * @return the new {@code TestObserver} instance
* @since 2.0
*/
@CheckReturnValue
@@ -4195,16 +4294,16 @@ public final TestObserver
*
*
- * @param dispose if true, the TestObserver will be cancelled before subscribing to this
- * Single.
- * @return the new TestObserver instance
+ * @param dispose if {@code true}, the {@code TestObserver} will be cancelled before subscribing to this
+ * {@code Single}.
+ * @return the new {@code TestObserver} instance
* @since 2.0
*/
@CheckReturnValue
@@ -4251,9 +4350,10 @@ private static 
*
@@ -4273,10 +4373,11 @@ private static 
*
@@ -4342,7 +4443,8 @@ public final CompletionStage
*
@@ -4383,7 +4485,8 @@ public final