diff --git a/src/main/java/io/reactivex/Completable.java b/src/main/java/io/reactivex/Completable.java index 66d19f052c..941f40ee48 100644 --- a/src/main/java/io/reactivex/Completable.java +++ b/src/main/java/io/reactivex/Completable.java @@ -1898,7 +1898,7 @@ public final Flowable toFlowable() { /** * Converts this Completable into a {@link Maybe}. *

- * + * *

*
Scheduler:
*
{@code toMaybe} does not operate by default on a particular {@link Scheduler}.
diff --git a/src/main/java/io/reactivex/Flowable.java b/src/main/java/io/reactivex/Flowable.java index 63648ac9aa..a672d8fbd0 100644 --- a/src/main/java/io/reactivex/Flowable.java +++ b/src/main/java/io/reactivex/Flowable.java @@ -48,7 +48,7 @@ *

* The documentation for this class makes use of marble diagrams. The following legend explains these diagrams: *

- * + * *

* For more information see the ReactiveX * documentation. @@ -1825,7 +1825,7 @@ public static Flowable fromArray(T... items) { * Returns a Flowable that, when a Subscriber subscribes to it, invokes a function you specify and then * emits the value returned from that function. *

- * + * *

* This allows you to defer the execution of the function you specify until a Subscriber subscribes to the * Publisher. That is to say, it makes the function "lazy." @@ -8189,7 +8189,7 @@ public final Single first(T defaultItem) { * Returns a Single that emits only the very first item emitted by this Flowable or * signals a {@link NoSuchElementException} if this Flowable is empty. *

- * + * *

*
Backpressure:
*
The operator honors backpressure from downstream and consumes the source {@code Publisher} in an @@ -9534,7 +9534,7 @@ public final Single last(T defaultItem) { * Returns a Single that emits only the last item emitted by this Flowable or signals * a {@link NoSuchElementException} if this Flowable is empty. *

- * + * *

*
Backpressure:
*
The operator honors backpressure from downstream and consumes the source {@code Publisher} in an @@ -10386,7 +10386,7 @@ public final Flowable onTerminateDetach() { *

* To merge the parallel 'rails' back into a single sequence, use {@link ParallelFlowable#sequential()}. *

- * + * *

*
Backpressure:
*
The operator requires the upstream to honor backpressure and each 'rail' honors backpressure @@ -10415,7 +10415,7 @@ public final ParallelFlowable parallel() { *

* To merge the parallel 'rails' back into a single sequence, use {@link ParallelFlowable#sequential()}. *

- * + * *

*
Backpressure:
*
The operator requires the upstream to honor backpressure and each 'rail' honors backpressure @@ -10447,7 +10447,7 @@ public final ParallelFlowable parallel(int parallelism) { *

* To merge the parallel 'rails' back into a single sequence, use {@link ParallelFlowable#sequential()}. *

- * + * *

*
Backpressure:
*
The operator requires the upstream to honor backpressure and each 'rail' honors backpressure @@ -11014,7 +11014,7 @@ public final Flowable replay(Function, ? extends Publ * emitted by a {@link ConnectableFlowable} that shares a single subscription to the source Publisher, * replaying no more than {@code bufferSize} items that were emitted within a specified time window. *

- * + * *

*
Backpressure:
*
This operator supports backpressure. Note that the upstream requests are determined by the child @@ -11718,7 +11718,7 @@ public final Flowable sample(long period, TimeUnit unit) { * Returns a Flowable that emits the most recently emitted item (if any) emitted by the source Publisher * within periodic time intervals and optionally emit the very last upstream item when the upstream completes. *

- * + * *

*
Backpressure:
*
This operator does not support backpressure as it uses time to control data flow.
@@ -11787,7 +11787,7 @@ public final Flowable sample(long period, TimeUnit unit, Scheduler scheduler) * within periodic time intervals, where the intervals are defined on a particular Scheduler * and optionally emit the very last upstream item when the upstream completes. *

- * + * *

*
Backpressure:
*
This operator does not support backpressure as it uses time to control data flow.
@@ -11827,7 +11827,7 @@ public final Flowable sample(long period, TimeUnit unit, Scheduler scheduler, * emits the most recently emitted item (if any) emitted by the source Publisher since the previous * emission from the {@code sampler} Publisher. *

- * + * *

*
Backpressure:
*
This operator does not support backpressure as it uses the emissions of the {@code sampler} @@ -11858,7 +11858,7 @@ public final Flowable sample(Publisher sampler) { * emission from the {@code sampler} Publisher * and optionally emit the very last upstream item when the upstream or other Publisher complete. *

- * + * *

*
Backpressure:
*
This operator does not support backpressure as it uses the emissions of the {@code sampler} @@ -12146,7 +12146,7 @@ public final Single single(T defaultItem) { * if this Flowable completes without emitting any items a {@link NoSuchElementException} will be signalled and * if this Flowable emits more than one item, an {@code IllegalArgumentException} will be signalled. *

- * + * *

*
Backpressure:
*
The operator honors backpressure from downstream and consumes the source {@code Publisher} in an @@ -12988,7 +12988,7 @@ public final Flowable subscribeOn(Scheduler scheduler) { /** * Returns a Flowable that emits the items emitted by the source Publisher or the items of an alternate * Publisher if the source Publisher is empty. - * + * *

*

*
Backpressure:
@@ -15589,7 +15589,7 @@ public final Flowable> window( * Publisher emits connected, non-overlapping windows. It emits the current window and opens a new one * whenever the Publisher produced by the specified {@code closingSelector} emits an item. *

- * + * *

*
Backpressure:
*
The operator consumes the source {@code Publisher} in an unbounded manner. @@ -15622,7 +15622,7 @@ public final Flowable> window(Callable> b * Publisher emits connected, non-overlapping windows. It emits the current window and opens a new one * whenever the Publisher produced by the specified {@code closingSelector} emits an item. *

- * + * *

*
Backpressure:
*
The operator consumes the source {@code Publisher} in an unbounded manner. diff --git a/src/main/java/io/reactivex/Maybe.java b/src/main/java/io/reactivex/Maybe.java index a538ef5550..dbb15efff4 100644 --- a/src/main/java/io/reactivex/Maybe.java +++ b/src/main/java/io/reactivex/Maybe.java @@ -35,7 +35,7 @@ /** * Represents a deferred computation and emission of a maybe value or exception. *

- * + * *

* The main consumer type of Maybe is {@link MaybeObserver} whose methods are called * in a sequential fashion following this protocol:
@@ -114,7 +114,7 @@ public static Flowable concat(Iterable /** * Returns a Flowable that emits the items emitted by two MaybeSources, one after the other. *

- * + * *

*
Backpressure:
*
The returned {@code Flowable} honors the backpressure of the downstream consumer.
@@ -143,7 +143,7 @@ public static Flowable concat(MaybeSource source1, MaybeSour /** * Returns a Flowable that emits the items emitted by three MaybeSources, one after the other. *

- * + * *

*
Backpressure:
*
The returned {@code Flowable} honors the backpressure of the downstream consumer.
@@ -176,7 +176,7 @@ public static Flowable concat( /** * Returns a Flowable that emits the items emitted by four MaybeSources, one after the other. *

- * + * *

*
Backpressure:
*
The returned {@code Flowable} honors the backpressure of the downstream consumer.
@@ -523,7 +523,7 @@ public static Maybe empty() { * Returns a Maybe that invokes a subscriber's {@link MaybeObserver#onError onError} method when the * subscriber subscribes to it. *

- * + * *

*
Scheduler:
*
{@code error} does not operate by default on a particular {@link Scheduler}.
@@ -745,7 +745,7 @@ public static Maybe fromRunnable(final Runnable run) { /** * Returns a {@code Maybe} that emits a specified item. *

- * + * *

* To convert any object into a {@code Maybe} that emits that object, pass that object into the * {@code just} method. @@ -834,7 +834,7 @@ public static Flowable merge(Publisher * Flattens a {@code MaybeSource} that emits a {@code MaybeSource} into a single {@code MaybeSource} that emits the item * emitted by the nested {@code MaybeSource}, without any transformation. *

- * + * *

*

*
Scheduler:
@@ -858,7 +858,7 @@ public static Maybe merge(MaybeSource> /** * Flattens two MaybeSources into a single Flowable, without any transformation. *

- * + * *

* You can combine items emitted by multiple MaybeSources so that they appear as a single Flowable, by * using the {@code merge} method. @@ -892,7 +892,7 @@ public static Flowable merge( /** * Flattens three MaybeSources into a single Flowable, without any transformation. *

- * + * *

* You can combine items emitted by multiple MaybeSources so that they appear as a single Flowable, by using * the {@code merge} method. @@ -930,7 +930,7 @@ public static Flowable merge( /** * Flattens four MaybeSources into a single Flowable, without any transformation. *

- * + * *

* You can combine items emitted by multiple MaybeSources so that they appear as a single Flowable, by using * the {@code merge} method. @@ -2090,7 +2090,7 @@ public final Maybe compose(MaybeTransformer trans * Returns a Maybe that is based on applying a specified function to the item emitted by the source Maybe, * where that function returns a MaybeSource. *

- * + * *

*
Scheduler:
*
{@code concatMap} does not operate by default on a particular {@link Scheduler}.
@@ -2598,7 +2598,7 @@ public final Maybe filter(Predicate predicate) { * Returns a Maybe that is based on applying a specified function to the item emitted by the source Maybe, * where that function returns a MaybeSource. *

- * + * *

*
Scheduler:
*
{@code flatMap} does not operate by default on a particular {@link Scheduler}.
@@ -2734,7 +2734,7 @@ public final Observable flattenAsObservable(final Function - * + * *
*
Scheduler:
*
{@code flatMapObservable} does not operate by default on a particular {@link Scheduler}.
@@ -2756,7 +2756,7 @@ public final Observable flatMapObservable(Function - * + * *
*
Backpressure:
*
The returned Flowable honors the downstream backpressure.
@@ -2783,7 +2783,7 @@ public final Flowable flatMapPublisher(Function - * + * *
*
Scheduler:
*
{@code flatMapSingle} does not operate by default on a particular {@link Scheduler}.
@@ -2808,7 +2808,7 @@ public final Single flatMapSingle(final Function - * + * *
*
Scheduler:
*
{@code flatMapSingleElement} does not operate by default on a particular {@link Scheduler}.
@@ -2834,7 +2834,7 @@ public final Maybe flatMapSingleElement(final Function - * + * *
*
Scheduler:
*
{@code flatMapCompletable} does not operate by default on a particular {@link Scheduler}.
@@ -2940,7 +2940,7 @@ public final Maybe lift(final MaybeOperator lift) * Returns a Maybe that applies a specified function to the item emitted by the source Maybe and * emits the result of this function application. *

- * + * *

*
Scheduler:
*
{@code map} does not operate by default on a particular {@link Scheduler}.
@@ -2990,7 +2990,7 @@ public final Flowable mergeWith(MaybeSource other) { * Wraps a Maybe to emit its item (or notify of its error) on a specified {@link Scheduler}, * asynchronously. *

- * + * *

*
Scheduler:
*
you specify which {@link Scheduler} this operator will use
@@ -3275,7 +3275,7 @@ public final Maybe onErrorReturnItem(final T item) { * This differs from {@link #onErrorResumeNext} in that this one does not handle {@link java.lang.Throwable} * or {@link java.lang.Error} but lets those continue through. *

- * + * *

* You can use this to prevent exceptions from propagating or to supply fallback data should exceptions be * encountered. @@ -3724,7 +3724,7 @@ public final void subscribe(MaybeObserver observer) { /** * Asynchronously subscribes subscribers to this Maybe on the specified {@link Scheduler}. *

- * + * *

*
Scheduler:
*
you specify which {@link Scheduler} this operator will use
@@ -3778,7 +3778,7 @@ public final > E subscribeWith(E observer) { * Returns a Maybe that emits the items emitted by the source Maybe or the items of an alternate * MaybeSource if the current Maybe is empty. *

- * + * *

*

*
Scheduler:
diff --git a/src/main/java/io/reactivex/Observable.java b/src/main/java/io/reactivex/Observable.java index 6c8c6dadd5..169073a5b5 100644 --- a/src/main/java/io/reactivex/Observable.java +++ b/src/main/java/io/reactivex/Observable.java @@ -47,7 +47,7 @@ *

* The documentation for this class makes use of marble diagrams. The following legend explains these diagrams: *

- * + * *

* For more information see the ReactiveX * documentation. @@ -1559,7 +1559,7 @@ public static Observable fromArray(T... items) { * Returns an Observable that, when an observer subscribes to it, invokes a function you specify and then * emits the value returned from that function. *

- * + * *

* This allows you to defer the execution of the function you specify until an observer subscribes to the * ObservableSource. That is to say, it makes the function "lazy." @@ -9088,7 +9088,7 @@ public final Observable replay(Function, ? extends * emitted by a {@link ConnectableObservable} that shares a single subscription to the source ObservableSource, * replaying no more than {@code bufferSize} items that were emitted within a specified time window. *

- * + * *

*
Scheduler:
*
You specify which {@link Scheduler} this operator will use
@@ -9698,7 +9698,7 @@ public final Observable sample(long period, TimeUnit unit) { * Returns an Observable that emits the most recently emitted item (if any) emitted by the source ObservableSource * within periodic time intervals and optionally emit the very last upstream item when the upstream completes. *

- * + * *

*
Scheduler:
*
{@code sample} operates by default on the {@code computation} {@link Scheduler}.
@@ -9759,7 +9759,7 @@ public final Observable sample(long period, TimeUnit unit, Scheduler schedule * within periodic time intervals, where the intervals are defined on a particular Scheduler * and optionally emit the very last upstream item when the upstream completes. *

- * + * *

*
Scheduler:
*
You specify which {@link Scheduler} this operator will use
@@ -9795,7 +9795,7 @@ public final Observable sample(long period, TimeUnit unit, Scheduler schedule * emits the most recently emitted item (if any) emitted by the source ObservableSource since the previous * emission from the {@code sampler} ObservableSource. *

- * + * *

*
Scheduler:
*
This version of {@code sample} does not operate by default on a particular {@link Scheduler}.
@@ -9821,7 +9821,7 @@ public final Observable sample(ObservableSource sampler) { * emission from the {@code sampler} ObservableSource * and optionally emit the very last upstream item when the upstream or other ObservableSource complete. *

- * + * *

*
Scheduler:
*
This version of {@code sample} does not operate by default on a particular {@link Scheduler}.
@@ -10779,7 +10779,7 @@ public final Observable subscribeOn(Scheduler scheduler) { /** * Returns an Observable that emits the items emitted by the source ObservableSource or the items of an alternate * ObservableSource if the source ObservableSource is empty. - * + * *

*

*
Scheduler:
@@ -13041,7 +13041,7 @@ public final Observable> window( * ObservableSource emits connected, non-overlapping windows. It emits the current window and opens a new one * whenever the ObservableSource produced by the specified {@code closingIndicator} emits an item. *

- * + * *

* if left unconsumed.
*
Scheduler:
@@ -13068,7 +13068,7 @@ public final Observable> window(Callable - * + * *
*
Scheduler:
*
This version of {@code window} does not operate by default on a particular {@link Scheduler}.
diff --git a/src/main/java/io/reactivex/Single.java b/src/main/java/io/reactivex/Single.java index a15fb2a5b7..3f2b898aa2 100644 --- a/src/main/java/io/reactivex/Single.java +++ b/src/main/java/io/reactivex/Single.java @@ -48,7 +48,7 @@ *

* The documentation for this class makes use of marble diagrams. The following legend explains these diagrams: *

- * + * *

* For more information see the ReactiveX * documentation. @@ -1962,7 +1962,7 @@ public final Single flatMap(Function - * + * *

*
Scheduler:
*
{@code flatMapMaybe} does not operate by default on a particular {@link Scheduler}.
@@ -2084,7 +2084,7 @@ public final Observable flatMapObservable(Function - * + * *
*
Scheduler:
*
{@code flatMapCompletable} does not operate by default on a particular {@link Scheduler}.
diff --git a/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableMostRecent.java b/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableMostRecent.java index 227d6ac959..12703a7cee 100644 --- a/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableMostRecent.java +++ b/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableMostRecent.java @@ -24,7 +24,7 @@ * Returns an Iterable that always returns the item most recently emitted by an Observable, or a * seed value if no item has yet been emitted. *

- * + * * * @param the value type */ diff --git a/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableNext.java b/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableNext.java index 6c505fd50a..9fd3c09d00 100644 --- a/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableNext.java +++ b/src/main/java/io/reactivex/internal/operators/flowable/BlockingFlowableNext.java @@ -27,7 +27,7 @@ /** * Returns an Iterable that blocks until the Observable emits another item, then returns that item. *

- * + * * * @param the value type */ diff --git a/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableMostRecent.java b/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableMostRecent.java index e414676a33..047770dd86 100644 --- a/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableMostRecent.java +++ b/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableMostRecent.java @@ -24,7 +24,7 @@ * Returns an Iterable that always returns the item most recently emitted by an Observable, or a * seed value if no item has yet been emitted. *

- * + * * * @param the value type */ diff --git a/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableNext.java b/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableNext.java index d0b3e13555..33d7b6525c 100644 --- a/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableNext.java +++ b/src/main/java/io/reactivex/internal/operators/observable/BlockingObservableNext.java @@ -25,7 +25,7 @@ /** * Returns an Iterable that blocks until the Observable emits another item, then returns that item. *

- * + * * * @param the value type */ diff --git a/src/main/java/io/reactivex/parallel/ParallelFlowable.java b/src/main/java/io/reactivex/parallel/ParallelFlowable.java index 71664eb8c3..8622922dd5 100644 --- a/src/main/java/io/reactivex/parallel/ParallelFlowable.java +++ b/src/main/java/io/reactivex/parallel/ParallelFlowable.java @@ -238,7 +238,7 @@ public final ParallelFlowable reduce(Callable initialSupplier, BiFunct * for the rails. *

* This operator uses the default prefetch size returned by {@code Flowable.bufferSize()}. - * + * *

*
Backpressure:
*
The operator honors backpressure.
@@ -259,7 +259,7 @@ public final Flowable sequential() { * Merges the values from each 'rail' in a round-robin or same-order fashion and * exposes it as a regular Publisher sequence, running with a give prefetch value * for the rails. - * + * *
*
Backpressure:
*
The operator honors backpressure.
diff --git a/src/main/java/io/reactivex/processors/BehaviorProcessor.java b/src/main/java/io/reactivex/processors/BehaviorProcessor.java index ca579ef9dd..3b81f6d062 100644 --- a/src/main/java/io/reactivex/processors/BehaviorProcessor.java +++ b/src/main/java/io/reactivex/processors/BehaviorProcessor.java @@ -31,7 +31,7 @@ * Processor that emits the most recent item it has observed and all subsequent observed items to each subscribed * {@link Subscriber}. *

- * + * *

* Example usage: *

diff --git a/src/main/java/io/reactivex/processors/PublishProcessor.java b/src/main/java/io/reactivex/processors/PublishProcessor.java index b6e73b014b..86abf96cab 100644 --- a/src/main/java/io/reactivex/processors/PublishProcessor.java +++ b/src/main/java/io/reactivex/processors/PublishProcessor.java @@ -26,7 +26,7 @@ * A Subject that multicasts events to Subscribers that are currently subscribed to it. * *

- * + * * *

The subject does not coordinate backpressure for its subscribers and implements a weaker onSubscribe which * calls requests Long.MAX_VALUE from the incoming Subscriptions. This makes it possible to subscribe the PublishSubject diff --git a/src/main/java/io/reactivex/processors/ReplayProcessor.java b/src/main/java/io/reactivex/processors/ReplayProcessor.java index f2e183b822..4fd3a9d41b 100644 --- a/src/main/java/io/reactivex/processors/ReplayProcessor.java +++ b/src/main/java/io/reactivex/processors/ReplayProcessor.java @@ -30,7 +30,7 @@ /** * Replays events to Subscribers. *

- * + * * *

* The ReplayProcessor can be created in bounded and unbounded mode. It can be bounded by diff --git a/src/main/java/io/reactivex/subjects/BehaviorSubject.java b/src/main/java/io/reactivex/subjects/BehaviorSubject.java index 866b077c91..b0376ecec1 100644 --- a/src/main/java/io/reactivex/subjects/BehaviorSubject.java +++ b/src/main/java/io/reactivex/subjects/BehaviorSubject.java @@ -29,7 +29,7 @@ * Subject that emits the most recent item it has observed and all subsequent observed items to each subscribed * {@link Observer}. *

- * + * *

* Example usage: *

diff --git a/src/main/java/io/reactivex/subjects/PublishSubject.java b/src/main/java/io/reactivex/subjects/PublishSubject.java index ba03f941ea..297e6e6363 100644 --- a/src/main/java/io/reactivex/subjects/PublishSubject.java +++ b/src/main/java/io/reactivex/subjects/PublishSubject.java @@ -24,7 +24,7 @@ * Subject that, once an {@link Observer} has subscribed, emits all subsequently observed items to the * subscriber. *

- * + * *

* Example usage: *

diff --git a/src/main/java/io/reactivex/subjects/ReplaySubject.java b/src/main/java/io/reactivex/subjects/ReplaySubject.java index 3d8845c959..286125d7eb 100644 --- a/src/main/java/io/reactivex/subjects/ReplaySubject.java +++ b/src/main/java/io/reactivex/subjects/ReplaySubject.java @@ -29,7 +29,7 @@ /** * Replays events to Observers. *

- * + * *

* Example usage: *