Remove 'Completable' prefix from nested interfaces, move its subscription to top-level. (#4425)

Author: JakeWharton

src/main/java/rx/Completable.java

@@ -0,0 +1,42 @@
+/*
+ * 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 rx;
+
+import rx.annotations.Experimental;
+
+/**
+ * Represents the subscription API callbacks when subscribing to a Completable instance.
+ */
+@Experimental
+public interface CompletableSubscriber {
+    /**
+     * Called once the deferred computation completes normally.
+     */
+    void onCompleted();
+
+    /**
+     * Called once if the deferred computation 'throws' an exception.
+     * @param e the exception, not null.
+     */
+    void onError(Throwable e);
+
+    /**
+     * Called once by the Completable to set a Subscription on this instance which
+     * then can be used to cancel the subscription at any time.
+     * @param d the Subscription instance to call dispose on for cancellation, not null
+     */
+    void onSubscribe(Subscription d);
+}

src/main/java/rx/CompletableSubscriber.java

@@ -2021,7 +2021,7 @@ public void onCompleted() {
                     }
                 };
 
-                final Completable.CompletableSubscriber so = new Completable.CompletableSubscriber() {
+                final CompletableSubscriber so = new CompletableSubscriber() {
                     @Override
                     public void onCompleted() {
                         onError(new CancellationException("Stream was canceled before emitting a terminal event."));

src/main/java/rx/Single.java

@@ -17,15 +17,15 @@
 package rx.internal.operators;
 
 import rx.Completable;
-import rx.Completable.CompletableOnSubscribe;
-import rx.Completable.CompletableSubscriber;
+import rx.Completable.OnSubscribe;
+import rx.CompletableSubscriber;
 import rx.Single;
 import rx.SingleSubscriber;
 import rx.Subscription;
 import rx.exceptions.Exceptions;
 import rx.functions.Func1;
 
-public final class CompletableFlatMapSingleToCompletable<T> implements CompletableOnSubscribe {
+public final class CompletableFlatMapSingleToCompletable<T> implements OnSubscribe {
 
     final Single<T> source;
 

src/main/java/rx/internal/operators/CompletableFlatMapSingleToCompletable.java

@@ -19,13 +19,13 @@
 import java.util.concurrent.atomic.*;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.exceptions.MissingBackpressureException;
 import rx.internal.util.unsafe.SpscArrayQueue;
 import rx.plugins.RxJavaHooks;
 import rx.subscriptions.SerialSubscription;
 
-public final class CompletableOnSubscribeConcat implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeConcat implements OnSubscribe {
     final Observable<Completable> sources;
     final int prefetch;
 

src/main/java/rx/internal/operators/CompletableOnSubscribeConcat.java

@@ -19,10 +19,10 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.subscriptions.SerialSubscription;
 
-public final class CompletableOnSubscribeConcatArray implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeConcatArray implements OnSubscribe {
     final Completable[] sources;
 
     public CompletableOnSubscribeConcatArray(Completable[] sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeConcatArray.java

@@ -20,10 +20,10 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.subscriptions.*;
 
-public final class CompletableOnSubscribeConcatIterable implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeConcatIterable implements OnSubscribe {
     final Iterable<? extends Completable> sources;
 
     public CompletableOnSubscribeConcatIterable(Iterable<? extends Completable> sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeConcatIterable.java

@@ -21,13 +21,13 @@
 import java.util.concurrent.atomic.*;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.Observable;
 import rx.exceptions.CompositeException;
 import rx.plugins.RxJavaHooks;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeMerge implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeMerge implements OnSubscribe {
     final Observable<Completable> source;
     final int maxConcurrency;
     final boolean delayErrors;

src/main/java/rx/internal/operators/CompletableOnSubscribeMerge.java

@@ -19,11 +19,11 @@
 import java.util.concurrent.atomic.*;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.plugins.RxJavaHooks;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeMergeArray implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeMergeArray implements OnSubscribe {
     final Completable[] sources;
 
     public CompletableOnSubscribeMergeArray(Completable[] sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeMergeArray.java

@@ -21,10 +21,10 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeMergeDelayErrorArray implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeMergeDelayErrorArray implements OnSubscribe {
     final Completable[] sources;
 
     public CompletableOnSubscribeMergeDelayErrorArray(Completable[] sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeMergeDelayErrorArray.java

@@ -20,11 +20,11 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.internal.util.unsafe.MpscLinkedQueue;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeMergeDelayErrorIterable implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeMergeDelayErrorIterable implements OnSubscribe {
     final Iterable<? extends Completable> sources;
 
     public CompletableOnSubscribeMergeDelayErrorIterable(Iterable<? extends Completable> sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeMergeDelayErrorIterable.java

@@ -20,11 +20,11 @@
 import java.util.concurrent.atomic.*;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.plugins.RxJavaHooks;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeMergeIterable implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeMergeIterable implements OnSubscribe {
     final Iterable<? extends Completable> sources;
 
     public CompletableOnSubscribeMergeIterable(Iterable<? extends Completable> sources) {

src/main/java/rx/internal/operators/CompletableOnSubscribeMergeIterable.java

@@ -20,12 +20,12 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import rx.*;
-import rx.Completable.*;
+import rx.Completable.OnSubscribe;
 import rx.functions.Action0;
 import rx.plugins.RxJavaHooks;
 import rx.subscriptions.CompositeSubscription;
 
-public final class CompletableOnSubscribeTimeout implements CompletableOnSubscribe {
+public final class CompletableOnSubscribeTimeout implements OnSubscribe {
 
     final Completable source;
     final long timeout;

src/main/java/rx/internal/operators/CompletableOnSubscribeTimeout.java

@@ -16,7 +16,7 @@
 package rx.internal.operators;
 
 import rx.*;
-import rx.Completable.CompletableSubscriber;
+import rx.CompletableSubscriber;
 import rx.exceptions.AssemblyStackTraceException;
 
 /**
@@ -26,9 +26,9 @@
  *
  * @param <T> the value type
  */
-public final class OnSubscribeOnAssemblyCompletable<T> implements Completable.CompletableOnSubscribe {
+public final class OnSubscribeOnAssemblyCompletable<T> implements Completable.OnSubscribe {
 
-    final Completable.CompletableOnSubscribe source;
+    final Completable.OnSubscribe source;
 
     final String stacktrace;
 
@@ -38,13 +38,13 @@ public final class OnSubscribeOnAssemblyCompletable<T> implements Completable.Co
      */
     public static volatile boolean fullStackTrace;
 
-    public OnSubscribeOnAssemblyCompletable(Completable.CompletableOnSubscribe source) {
+    public OnSubscribeOnAssemblyCompletable(Completable.OnSubscribe source) {
         this.source = source;
         this.stacktrace = OnSubscribeOnAssembly.createStacktrace();
     }
 
     @Override
-    public void call(Completable.CompletableSubscriber t) {
+    public void call(CompletableSubscriber t) {
         source.call(new OnAssemblyCompletableSubscriber(t, stacktrace));
     }
 

src/main/java/rx/internal/operators/OnSubscribeOnAssemblyCompletable.java

@@ -20,9 +20,8 @@
 import java.util.concurrent.atomic.AtomicReference;
 
 import rx.Completable;
-import rx.Completable.CompletableOnSubscribe;
-import rx.Completable.CompletableSubscriber;
-import rx.Scheduler.Worker;
+import rx.Completable.OnSubscribe;
+import rx.CompletableSubscriber;
 import rx.Observable;
 import rx.Observer;
 import rx.Scheduler;
@@ -143,7 +142,7 @@ public Worker createWorker() {
 		Observable<Completable> actions = actionSubject.map(new Func1<ScheduledAction, Completable>() {
 			@Override
 			public Completable call(final ScheduledAction action) {
-				return Completable.create(new CompletableOnSubscribe() {
+				return Completable.create(new OnSubscribe() {
 					@Override
 					public void call(CompletableSubscriber actionCompletable) {
 						actionCompletable.onSubscribe(action);

src/main/java/rx/internal/schedulers/SchedulerWhen.java

@@ -17,7 +17,7 @@
 
 import java.util.concurrent.atomic.AtomicReference;
 
-import rx.Completable.CompletableSubscriber;
+import rx.CompletableSubscriber;
 import rx.Subscription;
 import rx.annotations.Experimental;
 import rx.plugins.RxJavaHooks;

src/main/java/rx/observers/AsyncCompletableSubscriber.java

@@ -15,7 +15,7 @@
  */
 package rx.observers;
 
-import rx.Completable.CompletableSubscriber;
+import rx.CompletableSubscriber;
 import rx.Subscription;
 import rx.annotations.Experimental;
 import rx.exceptions.*;

src/main/java/rx/observers/SafeCompletableSubscriber.java

@@ -40,18 +40,18 @@
 @Experimental
 public abstract class RxJavaCompletableExecutionHook { // NOPMD 
     /**
-     * Invoked during the construction by {@link Completable#create(Completable.CompletableOnSubscribe)}
+     * Invoked during the construction by {@link Completable#create(Completable.OnSubscribe)}
      * <p>
      * This can be used to decorate or replace the <code>onSubscribe</code> function or just perform extra
      * logging, metrics and other such things and pass through the function.
      *
      * @param f
-     *            original {@link rx.Completable.CompletableOnSubscribe}<{@code T}> to be executed
-     * @return {@link rx.Completable.CompletableOnSubscribe} function that can be modified, decorated, replaced or just
+     *            original {@link Completable.OnSubscribe}<{@code T}> to be executed
+     * @return {@link Completable.OnSubscribe} function that can be modified, decorated, replaced or just
      *         returned as a pass through
      */
     @Deprecated
-    public Completable.CompletableOnSubscribe onCreate(Completable.CompletableOnSubscribe f) {
+    public Completable.OnSubscribe onCreate(Completable.OnSubscribe f) {
         return f;
     }
 
@@ -63,12 +63,12 @@ public Completable.CompletableOnSubscribe onCreate(Completable.CompletableOnSubs
      *
      * @param completableInstance the target completable instance
      * @param onSubscribe
-     *            original {@link rx.Completable.CompletableOnSubscribe}<{@code T}> to be executed
-     * @return {@link rx.Completable.CompletableOnSubscribe}<{@code T}> function that can be modified, decorated, replaced or just
+     *            original {@link Completable.OnSubscribe}<{@code T}> to be executed
+     * @return {@link Completable.OnSubscribe}<{@code T}> function that can be modified, decorated, replaced or just
      *         returned as a pass through
      */
     @Deprecated
-    public Completable.CompletableOnSubscribe onSubscribeStart(Completable completableInstance, final Completable.CompletableOnSubscribe onSubscribe) {
+    public Completable.OnSubscribe onSubscribeStart(Completable completableInstance, final Completable.OnSubscribe onSubscribe) {
         // pass through by default
         return onSubscribe;
     }
@@ -93,16 +93,16 @@ public Throwable onSubscribeError(Throwable e) {
      * Invoked just as the operator functions is called to bind two operations together into a new
      * {@link Completable} and the return value is used as the lifted function
      * <p>
-     * This can be used to decorate or replace the {@link rx.Completable.CompletableOperator} instance or just perform extra
+     * This can be used to decorate or replace the {@link Completable.Operator} instance or just perform extra
      * logging, metrics and other such things and pass through the onSubscribe.
      *
      * @param lift
-     *            original {@link rx.Completable.CompletableOperator}{@code <R, T>}
-     * @return {@link rx.Completable.CompletableOperator}{@code <R, T>} function that can be modified, decorated, replaced or just
+     *            original {@link Completable.Operator}{@code <R, T>}
+     * @return {@link Completable.Operator}{@code <R, T>} function that can be modified, decorated, replaced or just
      *         returned as a pass through
      */
     @Deprecated
-    public Completable.CompletableOperator onLift(final Completable.CompletableOperator lift) {
+    public Completable.Operator onLift(final Completable.Operator lift) {
         return lift;
     }
 }