2.x: Rename Completable Base Interface Types for consistency (ReactiveX#4302)

Author: vanniktech

src/main/java/io/reactivex/Completable.java

@@ -18,7 +18,7 @@
 /**
  * Represents the subscription API callbacks when subscribing to a Completable instance.
  */
-public interface CompletableSubscriber {
+public interface CompletableObserver {
     /**
      * Called once the deferred computation completes normally.
      */
@@ -36,4 +36,4 @@ public interface CompletableSubscriber {
      * @param d the Disposable instance to call dispose on for cancellation, not null
      */
     void onSubscribe(Disposable d);
-}
+}

…/io/reactivex/CompletableSubscriber.java …va/io/reactivex/CompletableObserver.javasrc/main/java/io/reactivex/CompletableSubscriber.java renamed to src/main/java/io/reactivex/CompletableObserver.java src/main/java/io/reactivex/CompletableSubscriber.java renamed to src/main/java/io/reactivex/CompletableObserver.java

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2016 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
+ * the License for the specific language governing permissions and limitations under the License.
+ */
+
+package io.reactivex;
+
+import io.reactivex.functions.Function;
+
+/**
+ * Convenience interface and callback used by the lift operator that given a child CompletableSubscriber,
+ * return a parent CompletableSubscriber that does any kind of lifecycle-related transformations.
+ */
+public interface CompletableOperator extends Function<CompletableObserver, CompletableObserver> {
+
+}

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

@@ -14,14 +14,14 @@
 
 /**
  * Represents a basic {@link Completable} source base interface,
- * consumable via an {@link CompletableSubscriber}.
+ * consumable via an {@link CompletableObserver}.
  * <p>
  * This class also serves the base type for custom operators wrapped into
- * Completable via {@link Completable#create(CompletableConsumable)}.
+ * Completable via {@link Completable#create(CompletableSource)}.
  * 
  * @since 2.0
  */
-public interface CompletableConsumable {
+public interface CompletableSource {
 
-    void subscribe(CompletableSubscriber cs);
+    void subscribe(CompletableObserver cs);
 }

…/io/reactivex/CompletableConsumable.java …java/io/reactivex/CompletableSource.javasrc/main/java/io/reactivex/CompletableConsumable.java renamed to src/main/java/io/reactivex/CompletableSource.java src/main/java/io/reactivex/CompletableConsumable.java renamed to src/main/java/io/reactivex/CompletableSource.java

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2016 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
+ * the License for the specific language governing permissions and limitations under the License.
+ */
+
+package io.reactivex;
+
+import io.reactivex.functions.Function;
+
+/**
+ * Convenience interface and callback used by the compose operator to turn a Completable into another
+ * Completable fluently.
+ */
+public interface CompletableTransformer extends Function<Completable, CompletableSource> {
+
+}

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

@@ -633,7 +633,7 @@ public final Single<T> delay(final long time, final TimeUnit unit, final Schedul
         return new SingleDelay<T>(this, time, unit, scheduler);
     }
 
-    public final Single<T> delaySubscription(CompletableConsumable other) {
+    public final Single<T> delaySubscription(CompletableSource other) {
         return new SingleDelayWithCompletable<T>(this, other);
     }
 

src/main/java/io/reactivex/Single.java

@@ -40,12 +40,12 @@ public static void error(Throwable e, Observer<?> s) {
         s.onError(e);
     }
 
-    public static void complete(CompletableSubscriber s) {
+    public static void complete(CompletableObserver s) {
         s.onSubscribe(INSTANCE);
         s.onComplete();
     }
 
-    public static void error(Throwable e, CompletableSubscriber s) {
+    public static void error(Throwable e, CompletableObserver s) {
         s.onSubscribe(INSTANCE);
         s.onError(e);
     }

src/main/java/io/reactivex/internal/disposables/EmptyDisposable.java

@@ -21,20 +21,20 @@
 
 public final class CompletableAmbArray extends Completable {
 
-    final CompletableConsumable[] sources;
+    final CompletableSource[] sources;
 
-    public CompletableAmbArray(CompletableConsumable[] sources) {
+    public CompletableAmbArray(CompletableSource[] sources) {
         this.sources = sources;
     }
 
     @Override
-    public void subscribeActual(final CompletableSubscriber s) {
+    public void subscribeActual(final CompletableObserver s) {
         final CompositeDisposable set = new CompositeDisposable();
         s.onSubscribe(set);
 
         final AtomicBoolean once = new AtomicBoolean();
 
-        CompletableSubscriber inner = new CompletableSubscriber() {
+        CompletableObserver inner = new CompletableObserver() {
             @Override
             public void onComplete() {
                 if (once.compareAndSet(false, true)) {
@@ -60,7 +60,7 @@ public void onSubscribe(Disposable d) {
 
         };
 
-        for (CompletableConsumable c : sources) {
+        for (CompletableSource c : sources) {
             if (set.isDisposed()) {
                 return;
             }

src/main/java/io/reactivex/internal/operators/completable/CompletableAmbArray.java

@@ -22,18 +22,18 @@
 
 public final class CompletableAmbIterable extends Completable {
 
-    final Iterable<? extends CompletableConsumable> sources;
+    final Iterable<? extends CompletableSource> sources;
 
-    public CompletableAmbIterable(Iterable<? extends CompletableConsumable> sources) {
+    public CompletableAmbIterable(Iterable<? extends CompletableSource> sources) {
         this.sources = sources;
     }
 
     @Override
-    protected void subscribeActual(final CompletableSubscriber s) {
+    protected void subscribeActual(final CompletableObserver s) {
         final CompositeDisposable set = new CompositeDisposable();
         s.onSubscribe(set);
 
-        Iterator<? extends CompletableConsumable> it;
+        Iterator<? extends CompletableSource> it;
 
         try {
             it = sources.iterator();
@@ -51,7 +51,7 @@ protected void subscribeActual(final CompletableSubscriber s) {
 
         final AtomicBoolean once = new AtomicBoolean();
 
-        CompletableSubscriber inner = new CompletableSubscriber() {
+        CompletableObserver inner = new CompletableObserver() {
             @Override
             public void onComplete() {
                 if (once.compareAndSet(false, true)) {
@@ -109,7 +109,7 @@ public void onSubscribe(Disposable d) {
                 return;
             }
 
-            CompletableConsumable c;
+            CompletableSource c;
 
             try {
                 c = it.next();

src/main/java/io/reactivex/internal/operators/completable/CompletableAmbIterable.java

@@ -23,11 +23,11 @@
 public enum CompletableAwait {
     ;
 
-    public static void await(CompletableConsumable cc) {
+    public static void await(CompletableSource cc) {
         final CountDownLatch cdl = new CountDownLatch(1);
         final Throwable[] err = new Throwable[1];
 
-        cc.subscribe(new CompletableSubscriber() {
+        cc.subscribe(new CompletableObserver() {
 
             @Override
             public void onComplete() {
@@ -63,13 +63,13 @@ public void onSubscribe(Disposable d) {
         }
     }
 
-    public static boolean await(CompletableConsumable cc, long timeout, TimeUnit unit) {
+    public static boolean await(CompletableSource cc, long timeout, TimeUnit unit) {
         Objects.requireNonNull(unit, "unit is null");
 
         final CountDownLatch cdl = new CountDownLatch(1);
         final Throwable[] err = new Throwable[1];
 
-        cc.subscribe(new CompletableSubscriber() {
+        cc.subscribe(new CompletableObserver() {
 
             @Override
             public void onComplete() {
@@ -109,11 +109,11 @@ public void onSubscribe(Disposable d) {
         return b;
     }
 
-    public static Throwable get(CompletableConsumable cc) {
+    public static Throwable get(CompletableSource cc) {
         final CountDownLatch cdl = new CountDownLatch(1);
         final Throwable[] err = new Throwable[1];
 
-        cc.subscribe(new CompletableSubscriber() {
+        cc.subscribe(new CompletableObserver() {
 
             @Override
             public void onComplete() {
@@ -144,13 +144,13 @@ public void onSubscribe(Disposable d) {
         return err[0];
     }
 
-    public static Throwable get(CompletableConsumable cc, long timeout, TimeUnit unit) {
+    public static Throwable get(CompletableSource cc, long timeout, TimeUnit unit) {
         Objects.requireNonNull(unit, "unit is null");
 
         final CountDownLatch cdl = new CountDownLatch(1);
         final Throwable[] err = new Throwable[1];
 
-        cc.subscribe(new CompletableSubscriber() {
+        cc.subscribe(new CompletableObserver() {
 
             @Override
             public void onComplete() {