Debian Codegraph @

src/main/java/io/reactivex/rxjava3/subjects/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 * Classes representing so-called hot sources, aka <strong>subjects</strong>, that implement a base reactive class and
16 * the respective consumer type at once to allow forms of multicasting events to multiple
17 * consumers as well as consuming another base reactive type of their kind.
18 * <p>
19 * Available subject classes with their respective base classes and consumer interfaces:
20 * <br>
21 * <table border="1" style="border-collapse: collapse;" summary="The available subject classes with their respective base classes and consumer interfaces.">
22 * <tr><td><b>Subject type</b></td><td><b>Base class</b></td><td><b>Consumer interface</b></td></tr>
23 * <tr>
24 * <td>{@link io.reactivex.rxjava3.subjects.Subject Subject}
25 * <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.rxjava3.subjects.AsyncSubject AsyncSubject}
26 * <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.rxjava3.subjects.BehaviorSubject BehaviorSubject}
27 * <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.rxjava3.subjects.PublishSubject PublishSubject}
28 * <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.rxjava3.subjects.ReplaySubject ReplaySubject}
29 * <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.rxjava3.subjects.UnicastSubject UnicastSubject}
30 * </td>
31 * <td>{@link io.reactivex.rxjava3.core.Observable Observable}</td>
32 * <td>{@link io.reactivex.rxjava3.core.Observer Observer}</td>
33 * </tr>
34 * <tr>
35 * <td>{@link io.reactivex.rxjava3.subjects.SingleSubject SingleSubject}</td>
36 * <td>{@link io.reactivex.rxjava3.core.Single Single}</td>
37 * <td>{@link io.reactivex.rxjava3.core.SingleObserver SingleObserver}</td>
38 * </tr>
39 * <tr>
40 * <td>{@link io.reactivex.rxjava3.subjects.MaybeSubject MaybeSubject}</td>
41 * <td>{@link io.reactivex.rxjava3.core.Maybe Maybe}</td>
42 * <td>{@link io.reactivex.rxjava3.core.MaybeObserver MaybeObserver}</td>
43 * </tr>
44 * <tr>
45 * <td>{@link io.reactivex.rxjava3.subjects.CompletableSubject CompletableSubject}</td>
46 * <td>{@link io.reactivex.rxjava3.core.Completable Completable}</td>
47 * <td>{@link io.reactivex.rxjava3.core.CompletableObserver CompletableObserver}</td>
48 * </tr>
49 * </table>
50 * <p>
51 * The backpressure-aware variants of the {@code Subject} class are called
52 * {@link org.reactivestreams.Processor}s and reside in the {@code io.reactivex.processors} package.
53 * @see io.reactivex.rxjava3.processors
54 */
55 package io.reactivex.rxjava3.subjects;