Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.x: Cleanup javadoc for parameter validation all around #6835

Merged
merged 3 commits into from
Jan 11, 2020
Merged

3.x: Cleanup javadoc for parameter validation all around #6835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e619af5
3.x: Cleanup javadoc for parameter validation all around
akarnokd Jan 10, 2020
a40d4e7
More cleanup
akarnokd Jan 10, 2020
939b3fc
Last set of intended changes
akarnokd Jan 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/main/java/io/reactivex/rxjava3/core/Completable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ public static Completable concat(@NonNull Iterable<? extends CompletableSource>
* </dl>
* @param sources the sources to concatenate
* @return the {@code Completable} instance which completes only when all sources complete
* @throws NullPointerException if sources is {@code null}
* @throws NullPointerException if {@code sources} is {@code null}
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
Expand Down Expand Up @@ -1655,6 +1655,7 @@ public final Completable doOnSubscribe(@NonNull Consumer<? super Disposable> onS
* </dl>
* @param onTerminate the {@code Action} to call just before this {@code Completable} terminates
* @return the new {@code Completable} instance
* @throws NullPointerException if {@code onTerminate} is {@code null}
* @see #doFinally(Action)
*/
@CheckReturnValue
Expand All @@ -1677,6 +1678,7 @@ public final Completable doOnTerminate(@NonNull Action onTerminate) {
* </dl>
* @param onAfterTerminate the {@code Action} to call after this {@code Completable} terminates
* @return the new {@code Completable} instance
* @throws NullPointerException if {@code onAfterTerminate} is {@code null}
* @see #doFinally(Action)
*/
@CheckReturnValue
Expand Down Expand Up @@ -2034,7 +2036,7 @@ public final Completable repeat() {
* </dl>
* @param times the number of times the re-subscription should happen
* @return the new {@code Completable} instance
* @throws IllegalArgumentException if times is less than zero
* @throws IllegalArgumentException if {@code times} is negative
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
Expand Down Expand Up @@ -2076,7 +2078,7 @@ public final Completable repeatUntil(@NonNull BooleanSupplier stop) {
* this {@code Completable} and returns a {@code Publisher} that emits items for repeating or completes to indicate the
* repetition should stop
* @return the new {@code Completable} instance
* @throws NullPointerException if {@code stop} is {@code null}
* @throws NullPointerException if {@code handler} is {@code null}
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
Expand Down Expand Up @@ -2619,7 +2621,7 @@ public final Completable timeout(long timeout, @NonNull TimeUnit unit, @NonNull
* @param other the other {@code Completable} instance to switch to in case of a timeout,
* if {@code null} a {@link TimeoutException} is emitted instead
* @return the new {@code Completable} instance
* @throws NullPointerException if {@code unit} or {@code scheduler}
* @throws NullPointerException if {@code unit}, {@code scheduler} or {@code other} is {@code null}
*/
@CheckReturnValue
@NonNull
Expand Down
3,095 changes: 1,812 additions & 1,283 deletions src/main/java/io/reactivex/rxjava3/core/Flowable.java
View file
Open in desktop

Large diffs are not rendered by default.

59 changes: 40 additions & 19 deletions src/main/java/io/reactivex/rxjava3/core/Maybe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ public static <T> Flowable<T> concat(
* @param <T> the value type
* @param sources the {@code Publisher} of {@code MaybeSource} instances
* @return the new {@code Flowable} instance
* @throws NullPointerException if {@code sources} is {@code null}
*/
@BackpressureSupport(BackpressureKind.FULL)
@CheckReturnValue
Expand Down Expand Up @@ -433,6 +434,7 @@ public static <T> Flowable<T> concatArrayDelayError(@NonNull MaybeSource<? exten
* @param <T> the value type
* @param sources a sequence of {@code MaybeSource}s that need to be eagerly concatenated
* @return the new {@code Flowable} instance with the specified concatenation behavior
* @throws NullPointerException if {@code sources} is {@code null}
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -488,6 +490,7 @@ public static <T> Flowable<T> concatDelayError(@NonNull Iterable<? extends Maybe
* @param <T> the common element base type
* @param sources the {@code Publisher} sequence of {@code MaybeSource}s
* @return the new {@code Flowable} with the concatenating behavior
* @throws NullPointerException if {@code sources} is {@code null}
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -515,6 +518,7 @@ public static <T> Flowable<T> concatDelayError(@NonNull Publisher<? extends Mayb
* @param <T> the value type
* @param sources a sequence of {@code MaybeSource} that need to be eagerly concatenated
* @return the new {@code Flowable} instance with the specified concatenation behavior
* @throws NullPointerException if {@code sources} is {@code null}
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -544,6 +548,7 @@ public static <T> Flowable<T> concatEager(@NonNull Iterable<? extends MaybeSourc
* @param <T> the value type
* @param sources a sequence of {@code MaybeSource}s that need to be eagerly concatenated
* @return the new {@code Flowable} instance with the specified concatenation behavior
* @throws NullPointerException if {@code sources} is {@code null}
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -1044,6 +1049,7 @@ public static <T> Flowable<T> merge(@NonNull Iterable<? extends MaybeSource<? ex
* @param <T> the common and resulting value type
* @param sources the {@code Flowable} sequence of {@code MaybeSource} sources
* @return the new {@code Flowable} instance
* @throws NullPointerException if {@code sources} is {@code null}
* @see #mergeDelayError(Publisher)
*/
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -1437,6 +1443,7 @@ public static <T> Flowable<T> mergeDelayError(@NonNull Iterable<? extends MaybeS
* a {@code Publisher} that emits {@code MaybeSource}s
* @return a {@code Flowable} that emits all of the items emitted by the {@code MaybeSource}s emitted by the
* {@code source} {@code Publisher}
* @throws NullPointerException if {@code sources} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/merge.html">ReactiveX operators documentation: Merge</a>
*/
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -1662,6 +1669,7 @@ public static <T> Maybe<T> never() {
* @param <T>
* the type of items emitted by each {@code MaybeSource}
* @return a {@code Single} that emits a {@code Boolean} value that indicates whether the two sequences are the same
* @throws NullPointerException if {@code source1} or {@code source2} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/sequenceequal.html">ReactiveX operators documentation: SequenceEqual</a>
*/
@CheckReturnValue
Expand Down Expand Up @@ -1720,6 +1728,7 @@ public static <T> Single<Boolean> sequenceEqual(@NonNull MaybeSource<? extends T
* @param unit
* time units to use for {@code delay}
* @return a {@code Maybe} that emits {@code 0L} after a specified delay
* @throws NullPointerException if {@code unit} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
*/
@CheckReturnValue
Expand Down Expand Up @@ -2688,6 +2697,7 @@ public final Single<T> defaultIfEmpty(@NonNull T defaultItem) {
* @param unit
* the {@link TimeUnit} in which {@code period} is defined
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code unit} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/delay.html">ReactiveX operators documentation: Delay</a>
* @see #delay(long, TimeUnit, Scheduler)
*/
Expand Down Expand Up @@ -2799,6 +2809,7 @@ public final <U> Maybe<T> delaySubscription(@NonNull Publisher<U> subscriptionIn
* @param unit
* the time unit of {@code delay}
* @return a {@code Maybe} that delays the subscription to the source {@code Maybe} by the given amount
* @throws NullPointerException if {@code unit} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/delay.html">ReactiveX operators documentation: Delay</a>
* @see #delaySubscription(long, TimeUnit, Scheduler)
*/
Expand Down Expand Up @@ -2827,6 +2838,7 @@ public final Maybe<T> delaySubscription(long delay, @NonNull TimeUnit unit) {
* the {@code Scheduler} on which the waiting and subscription will happen
* @return a {@code Maybe} that delays the subscription to the source {@code Maybe} by a given
* amount, waiting and subscribing on the given {@code Scheduler}
* @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/delay.html">ReactiveX operators documentation: Delay</a>
*/
@CheckReturnValue
Expand Down Expand Up @@ -4075,7 +4087,7 @@ public final Flowable<T> repeat() {
* @return a {@code Flowable} that repeats the sequence of items emitted by the source {@code Maybe} at most
* {@code count} times
* @throws IllegalArgumentException
* if {@code count} is less than zero
* if {@code times} is negative
* @see <a href="http://reactivex.io/documentation/operators/repeat.html">ReactiveX operators documentation: Repeat</a>
*/
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -4134,6 +4146,7 @@ public final Flowable<T> repeatUntil(@NonNull BooleanSupplier stop) {
* @param handler
* receives a {@code Publisher} of notifications with which a user can complete or error, aborting the repeat.
* @return the source {@code Publisher} modified with repeat logic
* @throws NullPointerException if {@code handler} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/repeat.html">ReactiveX operators documentation: Repeat</a>
*/
@BackpressureSupport(BackpressureKind.FULL)
Expand Down Expand Up @@ -4181,6 +4194,7 @@ public final Maybe<T> retry() {
* the predicate that determines if a resubscription may happen in case of a specific exception
* and retry count
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code predicate} is {@code null}
* @see #retry()
* @see <a href="http://reactivex.io/documentation/operators/retry.html">ReactiveX operators documentation: Retry</a>
*/
Expand All @@ -4205,16 +4219,17 @@ public final Maybe<T> retry(@NonNull BiPredicate<? super Integer, ? super Throwa
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd>
* </dl>
*
* @param count
* @param times
* the number of times to resubscribe if the current {@code Maybe} fails
* @return the new {@code Maybe} instance
* @throws IllegalArgumentException if {@code times} is negative
* @see <a href="http://reactivex.io/documentation/operators/retry.html">ReactiveX operators documentation: Retry</a>
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
@NonNull
public final Maybe<T> retry(long count) {
return retry(count, Functions.alwaysTrue());
public final Maybe<T> retry(long times) {
return retry(times, Functions.alwaysTrue());
}

/**
Expand All @@ -4227,6 +4242,8 @@ public final Maybe<T> retry(long count) {
* @param times the number of times to resubscribe if the current {@code Maybe} fails
* @param predicate the predicate called with the failure {@link Throwable} and should return {@code true} to trigger a retry.
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code predicate} is {@code null}
* @throws IllegalArgumentException if {@code times} is negative
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
Expand All @@ -4244,6 +4261,7 @@ public final Maybe<T> retry(long times, @NonNull Predicate<? super Throwable> pr
*
* @param predicate the predicate that receives the failure {@link Throwable} and should return {@code true} to trigger a retry.
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code predicate} is {@code null}
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.NONE)
Expand Down Expand Up @@ -4341,6 +4359,7 @@ public final Maybe<T> retryUntil(@NonNull BooleanSupplier stop) {
* receives a {@code Publisher} of notifications with which a user can complete or error, aborting the
* retry
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code handler} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/retry.html">ReactiveX operators documentation: Retry</a>
*/
@CheckReturnValue
Expand Down Expand Up @@ -4665,16 +4684,17 @@ public final <U> Maybe<T> takeUntil(@NonNull Publisher<U> other) {
*
* @param timeout
* maximum duration between emitted items before a timeout occurs
* @param timeUnit
* @param unit
* the unit of time that applies to the {@code timeout} argument.
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code unit} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/timeout.html">ReactiveX operators documentation: Timeout</a>
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.COMPUTATION)
@NonNull
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit) {
return timeout(timeout, timeUnit, Schedulers.computation());
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit unit) {
return timeout(timeout, unit, Schedulers.computation());
}

/**
Expand All @@ -4690,20 +4710,20 @@ public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit) {
*
* @param timeout
* maximum duration between items before a timeout occurs
* @param timeUnit
* @param unit
* the unit of time that applies to the {@code timeout} argument
* @param fallback
* the fallback {@code MaybeSource} to use in case of a timeout
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code timeUnit} or {@code fallback} is {@code null}
* @throws NullPointerException if {@code unit} or {@code fallback} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/timeout.html">ReactiveX operators documentation: Timeout</a>
*/
@CheckReturnValue
@NonNull
@SchedulerSupport(SchedulerSupport.COMPUTATION)
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit, @NonNull MaybeSource<? extends T> fallback) {
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit unit, @NonNull MaybeSource<? extends T> fallback) {
Objects.requireNonNull(fallback, "fallback is null");
return timeout(timeout, timeUnit, Schedulers.computation(), fallback);
return timeout(timeout, unit, Schedulers.computation(), fallback);
}

/**
Expand All @@ -4720,22 +4740,22 @@ public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit, @NonNull
*
* @param timeout
* maximum duration between items before a timeout occurs
* @param timeUnit
* @param unit
* the unit of time that applies to the {@code timeout} argument
* @param fallback
* the {@code MaybeSource} to use as the fallback in case of a timeout
* @param scheduler
* the {@code Scheduler} to run the timeout timers on
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code fallback}, {@code timeUnit} or {@code scheduler} is {@code null}
* @throws NullPointerException if {@code fallback}, {@code unit} or {@code scheduler} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/timeout.html">ReactiveX operators documentation: Timeout</a>
*/
@CheckReturnValue
@NonNull
@SchedulerSupport(SchedulerSupport.CUSTOM)
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit, @NonNull Scheduler scheduler, @NonNull MaybeSource<? extends T> fallback) {
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler, @NonNull MaybeSource<? extends T> fallback) {
Objects.requireNonNull(fallback, "fallback is null");
return timeout(timer(timeout, timeUnit, scheduler), fallback);
return timeout(timer(timeout, unit, scheduler), fallback);
}

/**
Expand All @@ -4752,18 +4772,19 @@ public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit, @NonNull
*
* @param timeout
* maximum duration between items before a timeout occurs
* @param timeUnit
* @param unit
* the unit of time that applies to the {@code timeout} argument
* @param scheduler
* the {@code Scheduler} to run the timeout timers on
* @return the new {@code Maybe} instance
* @see <a href="http://reactivex.io/documentation/operators/timeout.html">ReactiveX operators documentation: Timeout</a>
* @throws NullPointerException if {@code unit} or {@code scheduler} is {@code null}
*/
@CheckReturnValue
@SchedulerSupport(SchedulerSupport.CUSTOM)
@NonNull
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit timeUnit, @NonNull Scheduler scheduler) {
return timeout(timer(timeout, timeUnit, scheduler));
public final Maybe<T> timeout(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler) {
return timeout(timer(timeout, unit, scheduler));
}

/**
Expand Down Expand Up @@ -4909,7 +4930,7 @@ public final Maybe<T> unsubscribeOn(@NonNull Scheduler scheduler) {
* a function that combines the pairs of items from the two {@code MaybeSource}s to generate the items to
* be emitted by the resulting {@code Maybe}
* @return the new {@code Maybe} instance
* @throws NullPointerException if {@code other} is {@code null}
* @throws NullPointerException if {@code other} or {@code zipper} is {@code null}
* @see <a href="http://reactivex.io/documentation/operators/zip.html">ReactiveX operators documentation: Zip</a>
*/
@CheckReturnValue
Expand Down
Loading