autodispose2.SingleSubscribeProxy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of autodispose Show documentation

Automatic binding+disposal of RxJava 2+ streams.

There is a newer version: 2.2.1

/*
 * Copyright (C) 2019. Uber Technologies
 *
 * 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 autodispose2;

import io.reactivex.rxjava3.annotations.CheckReturnValue;
import io.reactivex.rxjava3.core.Single;
import io.reactivex.rxjava3.core.SingleObserver;
import io.reactivex.rxjava3.disposables.Disposable;
import io.reactivex.rxjava3.functions.BiConsumer;
import io.reactivex.rxjava3.functions.Consumer;
import io.reactivex.rxjava3.observers.TestObserver;

/** Subscribe proxy that matches {@link Single}'s subscribe overloads. */
public interface SingleSubscribeProxy {

  /**
   * Proxy for {@link Single#subscribe()}.
   *
   * @return a {@link Disposable}
   */
  Disposable subscribe();

  /**
   * Proxy for {@link Single#subscribe(Consumer)}.
   *
   * @return a {@link Disposable}
   */
  Disposable subscribe(Consumer onSuccess);

  /**
   * Proxy for {@link Single#subscribe(BiConsumer)}.
   *
   * @return a {@link Disposable}
   */
  Disposable subscribe(BiConsumer biConsumer);

  /**
   * Proxy for {@link Single#subscribe(Consumer, Consumer)}.
   *
   * @return a {@link Disposable}
   */
  Disposable subscribe(Consumer onSuccess, Consumer onError);

  /** Proxy for {@link Single#subscribe(SingleObserver)}. */
  void subscribe(SingleObserver observer);

  /**
   * Proxy for {@link Single#subscribeWith(SingleObserver)}.
   *
   * @return a {@link SingleObserver}
   */
  @CheckReturnValue
  > E subscribeWith(E observer);

  /**
   * Proxy for {@link Single#test()}.
   *
   * @return a {@link TestObserver}
   */
  @CheckReturnValue
  TestObserver test();

  /**
   * Proxy for {@link Single#test(boolean)}.
   *
   * @return a {@link TestObserver}
   */
  @CheckReturnValue
  TestObserver test(boolean dispose);
}