2.x: Add a few more @nullable & @nonnull annotations to public interfaces. (#5196)

Author: vanniktech

src/main/java/io/reactivex/CompletableEmitter.java

@@ -13,6 +13,7 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
 import io.reactivex.disposables.Disposable;
 import io.reactivex.functions.Cancellable;
 
@@ -35,21 +36,21 @@ public interface CompletableEmitter {
      * Signal an exception.
      * @param t the exception, not null
      */
-    void onError(Throwable t);
+    void onError(@NonNull Throwable t);
 
     /**
      * Sets a Disposable on this emitter; any previous Disposable
      * or Cancellation will be disposed/cancelled.
      * @param d the disposable, null is allowed
      */
-    void setDisposable(Disposable d);
+    void setDisposable(@Nullable Disposable d);
 
     /**
      * Sets a Cancellable on this emitter; any previous Disposable
      * or Cancellation will be disposed/cancelled.
      * @param c the cancellable resource, null is allowed
      */
-    void setCancellable(Cancellable c);
+    void setCancellable(@Nullable Cancellable c);
 
     /**
      * Returns true if the downstream disposed the sequence.

src/main/java/io/reactivex/CompletableObserver.java

@@ -13,6 +13,7 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.NonNull;
 import io.reactivex.disposables.Disposable;
 
 /**
@@ -24,7 +25,7 @@ public interface CompletableObserver {
      * then can be used to cancel the subscription at any time.
      * @param d the Disposable instance to call dispose on for cancellation, not null
      */
-    void onSubscribe(Disposable d);
+    void onSubscribe(@NonNull Disposable d);
 
     /**
      * Called once the deferred computation completes normally.
@@ -35,5 +36,5 @@ public interface CompletableObserver {
      * Called once if the deferred computation 'throws' an exception.
      * @param e the exception, not null.
      */
-    void onError(Throwable e);
+    void onError(@NonNull Throwable e);
 }

src/main/java/io/reactivex/CompletableOnSubscribe.java

@@ -12,6 +12,8 @@
  */
 package io.reactivex;
 
+import io.reactivex.annotations.*;
+
 /**
  * A functional interface that has a {@code subscribe()} method that receives
  * an instance of a {@link CompletableEmitter} instance that allows pushing
@@ -24,6 +26,6 @@ public interface CompletableOnSubscribe {
      * @param e the safe emitter instance, never null
      * @throws Exception on error
      */
-    void subscribe(CompletableEmitter e) throws Exception;
+    void subscribe(@NonNull CompletableEmitter e) throws Exception;
 }
 

src/main/java/io/reactivex/CompletableOperator.java

@@ -13,6 +13,8 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
+
 /**
  * Interface to map/wrap a downstream observer to an upstream observer.
  */
@@ -23,5 +25,6 @@ public interface CompletableOperator {
      * @return the parent CompletableObserver instance
      * @throws Exception on failure
      */
-    CompletableObserver apply(CompletableObserver observer) throws Exception;
+    @NonNull
+    CompletableObserver apply(@NonNull CompletableObserver observer) throws Exception;
 }

src/main/java/io/reactivex/CompletableSource.java

@@ -12,6 +12,8 @@
  */
 package io.reactivex;
 
+import io.reactivex.annotations.*;
+
 /**
  * Represents a basic {@link Completable} source base interface,
  * consumable via an {@link CompletableObserver}.
@@ -25,5 +27,5 @@ public interface CompletableSource {
      * @param cs the CompletableObserver, not null
      * @throws NullPointerException if {@code cs} is null
      */
-    void subscribe(CompletableObserver cs);
+    void subscribe(@NonNull CompletableObserver cs);
 }

src/main/java/io/reactivex/CompletableTransformer.java

@@ -13,6 +13,8 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
+
 /**
  * Convenience interface and callback used by the compose operator to turn a Completable into another
  * Completable fluently.
@@ -23,5 +25,6 @@ public interface CompletableTransformer {
      * @param upstream the upstream Completable instance
      * @return the transformed CompletableSource instance
      */
-    CompletableSource apply(Completable upstream);
+    @NonNull
+    CompletableSource apply(@NonNull Completable upstream);
 }

src/main/java/io/reactivex/FlowableEmitter.java

@@ -13,6 +13,7 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
 import io.reactivex.disposables.Disposable;
 import io.reactivex.functions.Cancellable;
 
@@ -35,14 +36,14 @@ public interface FlowableEmitter<T> extends Emitter<T> {
      * or Cancellation will be unsubscribed/cancelled.
      * @param s the disposable, null is allowed
      */
-    void setDisposable(Disposable s);
+    void setDisposable(@Nullable Disposable s);
 
     /**
      * Sets a Cancellable on this emitter; any previous Disposable
      * or Cancellation will be unsubscribed/cancelled.
      * @param c the cancellable resource, null is allowed
      */
-    void setCancellable(Cancellable c);
+    void setCancellable(@Nullable Cancellable c);
 
     /**
      * The current outstanding request amount.
@@ -62,5 +63,6 @@ public interface FlowableEmitter<T> extends Emitter<T> {
      * Ensures that calls to onNext, onError and onComplete are properly serialized.
      * @return the serialized FlowableEmitter
      */
+    @NonNull
     FlowableEmitter<T> serialize();
 }

src/main/java/io/reactivex/FlowableOnSubscribe.java

@@ -12,6 +12,8 @@
  */
 package io.reactivex;
 
+import io.reactivex.annotations.*;
+
 /**
  * A functional interface that has a {@code subscribe()} method that receives
  * an instance of a {@link FlowableEmitter} instance that allows pushing
@@ -26,6 +28,6 @@ public interface FlowableOnSubscribe<T> {
      * @param e the safe emitter instance, never null
      * @throws Exception on error
      */
-    void subscribe(FlowableEmitter<T> e) throws Exception;
+    void subscribe(@NonNull FlowableEmitter<T> e) throws Exception;
 }
 

src/main/java/io/reactivex/FlowableOperator.java

@@ -13,6 +13,7 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
 import org.reactivestreams.Subscriber;
 
 /**
@@ -28,5 +29,6 @@ public interface FlowableOperator<Downstream, Upstream> {
      * @return the parent Subscriber instance
      * @throws Exception on failure
      */
-    Subscriber<? super Upstream> apply(Subscriber<? super Downstream> observer) throws Exception;
+    @NonNull
+    Subscriber<? super Upstream> apply(@NonNull Subscriber<? super Downstream> observer) throws Exception;
 }

src/main/java/io/reactivex/FlowableSubscriber.java

@@ -13,10 +13,9 @@
 
 package io.reactivex;
 
+import io.reactivex.annotations.*;
 import org.reactivestreams.*;
 
-import io.reactivex.annotations.Experimental;
-
 /**
  * Represents a Reactive-Streams inspired Subscriber that is RxJava 2 only
  * and weakens rules §1.3 and §3.9 of the specification for gaining performance.
@@ -37,5 +36,5 @@ public interface FlowableSubscriber<T> extends Subscriber<T> {
      * {@inheritDoc}
      */
     @Override
-    void onSubscribe(Subscription s);
+    void onSubscribe(@NonNull Subscription s);
 }