Debian Codegraph @

src/main/java/io/reactivex/rxjava3/observers/package-info.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 /**
15 * Default wrappers and implementations for observer-based consumer classes and interfaces,
16 * including disposable and resource-tracking variants and
17 * the {@link io.reactivex.rxjava3.observers.TestObserver TestObserver} that allows unit testing
18 * {@link io.reactivex.rxjava3.core.Observable Observable}-, {@link io.reactivex.rxjava3.core.Single Single}-,
19 * {@link io.reactivex.rxjava3.core.Maybe Maybe}- and {@link io.reactivex.rxjava3.core.Completable Completable}-based flows.
20 * <p>
21 * Available observer variants
22 * <br>
23 * <table border="1" style="border-collapse: collapse;" summary="The available observer types.">
24 * <tr><td><b>Reactive type</b></td><td><b>Base interface</b></td><td><b>Simple</b></td><td><b>Disposable</b></td><td><b>Resource</b></td></tr>
25 * <tr>
26 * <td>{@link io.reactivex.rxjava3.core.Observable Observable}</td>
27 * <td>{@link io.reactivex.rxjava3.core.Observer Observer}</td>
28 * <td>{@link io.reactivex.rxjava3.observers.DefaultObserver DefaultObserver}</td>
29 * <td>{@link io.reactivex.rxjava3.observers.DisposableObserver DisposableObserver}</td>
30 * <td>{@link io.reactivex.rxjava3.observers.ResourceObserver DisposableObserver}</td>
31 * </tr>
32 * <tr>
33 * <td>{@link io.reactivex.rxjava3.core.Maybe Maybe}</td>
34 * <td>{@link io.reactivex.rxjava3.core.MaybeObserver MaybeObserver}</td>
35 * <td>N/A</td>
36 * <td>{@link io.reactivex.rxjava3.observers.DisposableMaybeObserver DisposableMaybeObserver}</td>
37 * <td>{@link io.reactivex.rxjava3.observers.ResourceMaybeObserver DisposableMaybeObserver}</td>
38 * </tr>
39 * <tr>
40 * <td>{@link io.reactivex.rxjava3.core.Single Single}</td>
41 * <td>{@link io.reactivex.rxjava3.core.SingleObserver SingleObserver}</td>
42 * <td>N/A</td>
43 * <td>{@link io.reactivex.rxjava3.observers.DisposableSingleObserver DisposableSingleObserver}</td>
44 * <td>{@link io.reactivex.rxjava3.observers.ResourceSingleObserver DisposableSingleObserver}</td>
45 * </tr>
46 * <tr>
47 * <td>{@link io.reactivex.rxjava3.core.Completable Completable}</td>
48 * <td>{@link io.reactivex.rxjava3.core.CompletableObserver CompletableObserver}</td>
49 * <td>N/A</td>
50 * <td>{@link io.reactivex.rxjava3.observers.DisposableCompletableObserver DisposableCompletableObserver}</td>
51 * <td>{@link io.reactivex.rxjava3.observers.ResourceCompletableObserver DisposableCompletableObserver}</td>
52 * </tr>
53 * </table>
54 */
55 package io.reactivex.rxjava3.observers;