Debian Codegraph @

src/main/java/io/reactivex/rxjava3/core/CompletableObserver.java

raw
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 notification of a valueless completion or an error.
21 * <p>
22 * When a {@code CompletableObserver} is subscribed to a {@link CompletableSource} through the {@link CompletableSource#subscribe(CompletableObserver)} method,
23 * the {@code CompletableSource} calls {@link #onSubscribe(Disposable)} with a {@link Disposable} that allows
24 * disposing the sequence at any time. A well-behaved
25 * {@code CompletableSource} will call a {@code CompletableObserver}'s {@link #onError(Throwable)}
26 * or {@link #onComplete()} method exactly once as they are considered mutually exclusive <strong>terminal signals</strong>.
27 * <p>
28 * Calling the {@code CompletableObserver}'s method must happen in a serialized fashion, that is, they must not
29 * be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must
30 * adhere to the following protocol:
31 * <pre><code> onSubscribe (onError | onComplete)?</code></pre>
32 * <p>
33 * Subscribing a {@code CompletableObserver} to multiple {@code CompletableSource}s is not recommended. If such reuse
34 * happens, it is the duty of the {@code CompletableObserver} implementation to be ready to receive multiple calls to
35 * its methods and ensure proper concurrent behavior of its business logic.
36 * <p>
37 * Calling {@link #onSubscribe(Disposable)} or {@link #onError(Throwable)} with a
38 * {@code null} argument is forbidden.
39 * <p>
40 * The implementations of the {@code onXXX} methods should avoid throwing runtime exceptions other than the following cases:
41 * <ul>
42 * <li>If the argument is {@code null}, the methods can throw a {@code NullPointerException}.
43 * Note though that RxJava prevents {@code null}s to enter into the flow and thus there is generally no
44 * need to check for nulls in flows assembled from standard sources and intermediate operators.
45 * </li>
46 * <li>If there is a fatal error (such as {@code VirtualMachineError}).</li>
47 * </ul>
48 * @since 2.0
49 */
50 public interface CompletableObserver {
51 /**
52 * Called once by the {@link Completable} to set a {@link Disposable} on this instance which
53 * then can be used to cancel the subscription at any time.
54 * @param d the {@code Disposable} instance to call dispose on for cancellation, not null
55 */
56 void onSubscribe(@NonNull Disposable d);
57
58 /**
59 * Called once the deferred computation completes normally.
60 */
61 void onComplete();
62
63 /**
64 * Called once if the deferred computation 'throws' an exception.
65 * @param e the exception, not {@code null}.
66 */
67 void onError(@NonNull Throwable e);
68 }