| 1 |
/* |
| 2 |
* Copyright (c) 2016-present, RxJava Contributors. |
| 3 |
* |
| 4 |
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in |
| 5 |
* compliance with the License. You may obtain a copy of the License at |
| 6 |
* |
| 7 |
* http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
* |
| 9 |
* Unless required by applicable law or agreed to in writing, software distributed under the License is |
| 10 |
* distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See |
| 11 |
* the License for the specific language governing permissions and limitations under the License. |
| 12 |
*/ |
| 13 |
|
| 14 |
package io.reactivex.rxjava3.core; |
| 15 |
|
| 16 |
import io.reactivex.rxjava3.annotations.NonNull; |
| 17 |
import io.reactivex.rxjava3.disposables.Disposable; |
| 18 |
|
| 19 |
/** |
| 20 |
* Provides a mechanism for receiving push-based notifications. |
| 21 |
* <p> |
| 22 |
* When an {@code Observer} is subscribed to an {@link ObservableSource} through the {@link ObservableSource#subscribe(Observer)} method, |
| 23 |
* the {@code ObservableSource} calls {@link #onSubscribe(Disposable)} with a {@link Disposable} that allows |
| 24 |
* disposing the sequence at any time, then the |
| 25 |
* {@code ObservableSource} may call the Observer's {@link #onNext} method any number of times |
| 26 |
* to provide notifications. A well-behaved |
| 27 |
* {@code ObservableSource} will call an {@code Observer}'s {@link #onComplete} method exactly once or the {@code Observer}'s |
| 28 |
* {@link #onError} method exactly once. |
| 29 |
* <p> |
| 30 |
* Calling the {@code Observer}'s method must happen in a serialized fashion, that is, they must not |
| 31 |
* be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must |
| 32 |
* adhere to the following protocol: |
| 33 |
* <pre><code> onSubscribe onNext* (onError | onComplete)?</code></pre> |
| 34 |
* <p> |
| 35 |
* Subscribing an {@code Observer} to multiple {@code ObservableSource}s is not recommended. If such reuse |
| 36 |
* happens, it is the duty of the {@code Observer} implementation to be ready to receive multiple calls to |
| 37 |
* its methods and ensure proper concurrent behavior of its business logic. |
| 38 |
* <p> |
| 39 |
* Calling {@link #onSubscribe(Disposable)}, {@link #onNext(Object)} or {@link #onError(Throwable)} with a |
| 40 |
* {@code null} argument is forbidden. |
| 41 |
* <p> |
| 42 |
* The implementations of the {@code onXXX} methods should avoid throwing runtime exceptions other than the following cases |
| 43 |
* (see <a href="https://github.com/reactive-streams/reactive-streams-jvm#2.13">Rule 2.13</a> of the Reactive Streams specification): |
| 44 |
* <ul> |
| 45 |
* <li>If the argument is {@code null}, the methods can throw a {@code NullPointerException}. |
| 46 |
* Note though that RxJava prevents {@code null}s to enter into the flow and thus there is generally no |
| 47 |
* need to check for nulls in flows assembled from standard sources and intermediate operators. |
| 48 |
* </li> |
| 49 |
* <li>If there is a fatal error (such as {@code VirtualMachineError}).</li> |
| 50 |
* </ul> |
| 51 |
* <p> |
| 52 |
* Violating Rule 2.13 results in undefined flow behavior. Generally, the following can happen: |
| 53 |
* <ul> |
| 54 |
* <li>An upstream operator turns it into an {@link #onError} call.</li> |
| 55 |
* <li>If the flow is synchronous, the {@link ObservableSource#subscribe(Observer)} throws instead of returning normally.</li> |
| 56 |
* <li>If the flow is asynchronous, the exception propagates up to the component ({@link Scheduler} or {@link java.util.concurrent.Executor}) |
| 57 |
* providing the asynchronous boundary the code is running and either routes the exception to the global |
| 58 |
* {@link io.reactivex.rxjava3.plugins.RxJavaPlugins#onError(Throwable)} handler or the current thread's |
| 59 |
* {@link java.lang.Thread.UncaughtExceptionHandler#uncaughtException(Thread, Throwable)} handler.</li> |
| 60 |
* </ul> |
| 61 |
* From the {@code Observable}'s perspective, an {@code Observer} is the end consumer thus it is the {@code Observer}'s |
| 62 |
* responsibility to handle the error case and signal it "further down". This means unreliable code in the {@code onXXX} |
| 63 |
* methods should be wrapped into `try-catch`es, specifically in {@link #onError(Throwable)} or {@link #onComplete()}, and handled there |
| 64 |
* (for example, by logging it or presenting the user with an error dialog). However, if the error would be thrown from |
| 65 |
* {@link #onNext(Object)}, <a href="https://github.com/reactive-streams/reactive-streams-jvm#2.13">Rule 2.13</a> mandates |
| 66 |
* the implementation calls {@link Disposable#dispose()} and signals the exception in a way that is adequate to the target context, |
| 67 |
* for example, by calling {@link #onError(Throwable)} on the same {@code Observer} instance. |
| 68 |
* <p> |
| 69 |
* If, for some reason, the {@code Observer} won't follow Rule 2.13, the {@link Observable#safeSubscribe(Observer)} can wrap it |
| 70 |
* with the necessary safeguards and route exceptions thrown from {@code onNext} into {@code onError} and route exceptions thrown |
| 71 |
* from {@code onError} and {@code onComplete} into the global error handler via {@link io.reactivex.rxjava3.plugins.RxJavaPlugins#onError(Throwable)}. |
| 72 |
* @see <a href="http://reactivex.io/documentation/observable.html">ReactiveX documentation: Observable</a> |
| 73 |
* @param <T> |
| 74 |
* the type of item the Observer expects to observe |
| 75 |
*/ |
| 76 |
public interface Observer<@NonNull T> { |
| 77 |
|
| 78 |
/** |
| 79 |
* Provides the {@link Observer} with the means of cancelling (disposing) the |
| 80 |
* connection (channel) with the {@link Observable} in both |
| 81 |
* synchronous (from within {@link #onNext(Object)}) and asynchronous manner. |
| 82 |
* @param d the {@link Disposable} instance whose {@link Disposable#dispose()} can |
| 83 |
* be called anytime to cancel the connection |
| 84 |
* @since 2.0 |
| 85 |
*/ |
| 86 |
void onSubscribe(@NonNull Disposable d); |
| 87 |
|
| 88 |
/** |
| 89 |
* Provides the {@link Observer} with a new item to observe. |
| 90 |
* <p> |
| 91 |
* The {@link Observable} may call this method 0 or more times. |
| 92 |
* <p> |
| 93 |
* The {@code Observable} will not call this method again after it calls either {@link #onComplete} or |
| 94 |
* {@link #onError}. |
| 95 |
* |
| 96 |
* @param t |
| 97 |
* the item emitted by the Observable |
| 98 |
*/ |
| 99 |
void onNext(@NonNull T t); |
| 100 |
|
| 101 |
/** |
| 102 |
* Notifies the {@link Observer} that the {@link Observable} has experienced an error condition. |
| 103 |
* <p> |
| 104 |
* If the {@code Observable} calls this method, it will not thereafter call {@link #onNext} or |
| 105 |
* {@link #onComplete}. |
| 106 |
* |
| 107 |
* @param e |
| 108 |
* the exception encountered by the Observable |
| 109 |
*/ |
| 110 |
void onError(@NonNull Throwable e); |
| 111 |
|
| 112 |
/** |
| 113 |
* Notifies the {@link Observer} that the {@link Observable} has finished sending push-based notifications. |
| 114 |
* <p> |
| 115 |
* The {@code Observable} will not call this method if it calls {@link #onError}. |
| 116 |
*/ |
| 117 |
void onComplete(); |
| 118 |
|
| 119 |
} |