Skip to content

Commit 85e1c4c

Browse files
authored
Update Readme.md with the new package locations (#6631)
1 parent c98416b commit 85e1c4c

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The second is to write the **Hello World** program:
5151
```java
5252
package rxjava.examples;
5353

54-
import io.reactivex.*;
54+
import io.reactivex.rxjava3.core.*;
5555

5656
public class HelloWorld {
5757
public static void main(String[] args) {
@@ -63,7 +63,7 @@ public class HelloWorld {
6363
If your platform doesn't support Java 8 lambdas (yet), you have to create an inner class of `Consumer` manually:
6464

6565
```java
66-
import io.reactivex.functions.Consumer;
66+
import io.reactivex.rxjava3.functions.Consumer;
6767

6868
Flowable.just("Hello world")
6969
.subscribe(new Consumer<String>() {
@@ -73,15 +73,17 @@ Flowable.just("Hello world")
7373
});
7474
```
7575

76+
Note that RxJava 3 components now live under `io.reactivex.rxjava3` and the base classes and interfaces live under `io.reactivex.rxjava3.core`.
77+
7678
### Base classes
7779

7880
RxJava 3 features several base classes you can discover operators on:
7981

80-
- [`io.reactivex.Flowable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/Flowable.html): 0..N flows, supporting Reactive-Streams and backpressure
81-
- [`io.reactivex.Observable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/Observable.html): 0..N flows, no backpressure,
82-
- [`io.reactivex.Single`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/Single.html): a flow of exactly 1 item or an error,
83-
- [`io.reactivex.Completable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/Completable.html): a flow without items but only a completion or error signal,
84-
- [`io.reactivex.Maybe`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/Maybe.html): a flow with no items, exactly one item or an error.
82+
- [`io.reactivex.rxjava3.core.Flowable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html): 0..N flows, supporting Reactive-Streams and backpressure
83+
- [`io.reactivex.rxjava3.core.Observable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html): 0..N flows, no backpressure,
84+
- [`io.reactivex.rxjava3.core.Single`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Single.html): a flow of exactly 1 item or an error,
85+
- [`io.reactivex.rxjava3.core.Completable`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Completable.html): a flow without items but only a completion or error signal,
86+
- [`io.reactivex.rxjava3.core.Maybe`](http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Maybe.html): a flow with no items, exactly one item or an error.
8587

8688
### Some terminology
8789

@@ -164,7 +166,7 @@ Practically, this is when the body of the given example above executes.
164166
One of the common use cases for RxJava is to run some computation, network request on a background thread and show the results (or error) on the UI thread:
165167

166168
```java
167-
import io.reactivex.schedulers.Schedulers;
169+
import io.reactivex.rxjava3.schedulers.Schedulers;
168170

169171
Flowable.fromCallable(() -> {
170172
Thread.sleep(1000); // imitate expensive computation
@@ -517,9 +519,9 @@ APIs marked with the [`@Experimental`][experimental source link] annotation at t
517519

518520
APIs marked with the `@Deprecated` annotation at the class or method level will remain supported until the next major release but it is recommended to stop using them.
519521

520-
#### io.reactivex.internal.*
522+
#### io.reactivex.rxjava3.internal.*
521523

522-
All code inside the `io.reactivex.internal.*` packages is considered private API and should not be relied upon at all. It can change at any time.
524+
All code inside the `io.reactivex.rxjava3.internal.*` packages is considered private API and should not be relied upon at all. It can change at any time.
523525

524526
## Full Documentation
525527

0 commit comments

Comments
 (0)