Skip to content

Commit ed5cd8b

Browse files
davidmotenakarnokd
authored andcommitted
correct javadoc for ConnectableFlowable, GroupedFlowable, FlowableAutoConnect (#5738)
1 parent fd4377f commit ed5cd8b

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

src/main/java/io/reactivex/flowables/ConnectableFlowable.java

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@
2525
import io.reactivex.plugins.RxJavaPlugins;
2626

2727
/**
28-
* A {@code ConnectableObservable} resembles an ordinary {@link Flowable}, except that it does not begin
28+
* A {@code ConnectableFlowable} resembles an ordinary {@link Flowable}, except that it does not begin
2929
* emitting items when it is subscribed to, but only when its {@link #connect} method is called. In this way you
30-
* can wait for all intended {@link Subscriber}s to {@link Flowable#subscribe} to the {@code Observable}
31-
* before the {@code Observable} begins emitting items.
30+
* can wait for all intended {@link Subscriber}s to {@link Flowable#subscribe} to the {@code Flowable}
31+
* before the {@code Flowable} begins emitting items.
3232
* <p>
3333
* <img width="640" height="510" src="https://github.com/ReactiveX/RxJava/wiki/images/rx-operators/publishConnect.png" alt="">
3434
*
3535
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Connectable-Observable-Operators">RxJava Wiki:
3636
* Connectable Observable Operators</a>
3737
* @param <T>
38-
* the type of items emitted by the {@code ConnectableObservable}
38+
* the type of items emitted by the {@code ConnectableFlowable}
3939
*/
4040
public abstract class ConnectableFlowable<T> extends Flowable<T> {
4141

4242
/**
43-
* Instructs the {@code ConnectableObservable} to begin emitting the items from its underlying
43+
* Instructs the {@code ConnectableFlowable} to begin emitting the items from its underlying
4444
* {@link Flowable} to its {@link Subscriber}s.
4545
*
4646
* @param connection
@@ -51,7 +51,7 @@ public abstract class ConnectableFlowable<T> extends Flowable<T> {
5151
public abstract void connect(@NonNull Consumer<? super Disposable> connection);
5252

5353
/**
54-
* Instructs the {@code ConnectableObservable} to begin emitting the items from its underlying
54+
* Instructs the {@code ConnectableFlowable} to begin emitting the items from its underlying
5555
* {@link Flowable} to its {@link Subscriber}s.
5656
* <p>
5757
* To disconnect from a synchronous source, use the {@link #connect(io.reactivex.functions.Consumer)} method.
@@ -66,8 +66,8 @@ public final Disposable connect() {
6666
}
6767

6868
/**
69-
* Returns an {@code Observable} that stays connected to this {@code ConnectableObservable} as long as there
70-
* is at least one subscription to this {@code ConnectableObservable}.
69+
* Returns a {@code Flowable} that stays connected to this {@code ConnectableFlowable} as long as there
70+
* is at least one subscription to this {@code ConnectableFlowable}.
7171
*
7272
* @return a {@link Flowable}
7373
* @see <a href="http://reactivex.io/documentation/operators/refcount.html">ReactiveX documentation: RefCount</a>
@@ -78,24 +78,24 @@ public Flowable<T> refCount() {
7878
}
7979

8080
/**
81-
* Returns an Observable that automatically connects to this ConnectableObservable
81+
* Returns a Flowable that automatically connects to this ConnectableFlowable
8282
* when the first Subscriber subscribes.
8383
*
84-
* @return an Observable that automatically connects to this ConnectableObservable
84+
* @return a Flowable that automatically connects to this ConnectableFlowable
8585
* when the first Subscriber subscribes
8686
*/
8787
@NonNull
8888
public Flowable<T> autoConnect() {
8989
return autoConnect(1);
9090
}
9191
/**
92-
* Returns an Observable that automatically connects to this ConnectableObservable
92+
* Returns a Flowable that automatically connects to this ConnectableFlowable
9393
* when the specified number of Subscribers subscribe to it.
9494
*
9595
* @param numberOfSubscribers the number of subscribers to await before calling connect
96-
* on the ConnectableObservable. A non-positive value indicates
96+
* on the ConnectableFlowable. A non-positive value indicates
9797
* an immediate connection.
98-
* @return an Observable that automatically connects to this ConnectableObservable
98+
* @return a Flowable that automatically connects to this ConnectableFlowable
9999
* when the specified number of Subscribers subscribe to it
100100
*/
101101
@NonNull
@@ -104,16 +104,16 @@ public Flowable<T> autoConnect(int numberOfSubscribers) {
104104
}
105105

106106
/**
107-
* Returns an Observable that automatically connects to this ConnectableObservable
107+
* Returns a Flowable that automatically connects to this ConnectableFlowable
108108
* when the specified number of Subscribers subscribe to it and calls the
109109
* specified callback with the Subscription associated with the established connection.
110110
*
111111
* @param numberOfSubscribers the number of subscribers to await before calling connect
112-
* on the ConnectableObservable. A non-positive value indicates
112+
* on the ConnectableFlowable. A non-positive value indicates
113113
* an immediate connection.
114114
* @param connection the callback Consumer that will receive the Subscription representing the
115115
* established connection
116-
* @return an Observable that automatically connects to this ConnectableObservable
116+
* @return a Flowable that automatically connects to this ConnectableFlowable
117117
* when the specified number of Subscribers subscribe to it and calls the
118118
* specified callback with the Subscription associated with the established connection
119119
*/

src/main/java/io/reactivex/flowables/GroupedFlowable.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* <p>
2121
* <em>Note:</em> A {@link GroupedFlowable} will cache the items it is to emit until such time as it
2222
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
23-
* {@code GroupedObservable}s that do not concern you. Instead, you can signal to them that they
23+
* {@code GroupedFlowable}s that do not concern you. Instead, you can signal to them that they
2424
* may discard their buffers by applying an operator like {@link Flowable#take take}{@code (0)} to them.
2525
*
2626
* @param <K>
@@ -43,9 +43,9 @@ protected GroupedFlowable(@Nullable K key) {
4343
}
4444

4545
/**
46-
* Returns the key that identifies the group of items emitted by this {@code GroupedObservable}.
46+
* Returns the key that identifies the group of items emitted by this {@code GroupedFlowable}.
4747
*
48-
* @return the key that the items emitted by this {@code GroupedObservable} were grouped by
48+
* @return the key that the items emitted by this {@code GroupedFlowable} were grouped by
4949
*/
5050
@Nullable
5151
public K getKey() {

src/main/java/io/reactivex/internal/operators/flowable/FlowableAutoConnect.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
import io.reactivex.functions.Consumer;
2424

2525
/**
26-
* Wraps a ConnectableObservable and calls its connect() method once
27-
* the specified number of Subscribers have subscribed.
26+
* Wraps a {@link ConnectableFlowable} and calls its {@code connect()} method once
27+
* the specified number of {@link Subscriber}s have subscribed.
2828
*
2929
* @param <T> the value type of the chain
3030
*/

0 commit comments

Comments
 (0)