Summary: Methods | Protected Methods | Inherited Methods | [Expand All]

public final class

CompletableSubject

extends Completable
implements CompletableObserver

java.lang.Object
↳	io.reactivex.Completable
	↳	io.reactivex.subjects.CompletableSubject

Class Overview

Represents a hot Completable-like source and consumer of events similar to Subjects.

All methods are thread safe. Calling onComplete multiple times has no effect. Calling onError multiple times relays the Throwable to the RxJavaPlugins' error handler.

The CompletableSubject doesn't store the Disposables coming through onSubscribe but disposes them once the other onXXX methods were called (terminal state reached).

History: 2.0.5 - experimental

Summary

Public Methods
static CompletableSubject	create() Creates a fresh CompletableSubject.
Throwable	getThrowable() Returns the terminal error if this CompletableSubject has been terminated with an error, null otherwise.
boolean	hasComplete() Returns true if this CompletableSubject has been completed.
boolean	hasObservers() Returns true if this CompletableSubject has observers.
boolean	hasThrowable() Returns true if this CompletableSubject has been terminated with an error.
void	onComplete() Called once the deferred computation completes normally.
void	onError(Throwable e) Called once if the deferred computation 'throws' an exception.
void	onSubscribe(Disposable d) Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.

Protected Methods
void	subscribeActual(CompletableObserver observer) Implement this to handle the incoming CompletableObserver and perform the business logic in your operator.

[Expand]

Inherited Methods

From class io.reactivex.Completable

static Completable	amb(Iterable<? extends CompletableSource> sources) Returns a Completable which terminates as soon as one of the source Completables terminates (normally or with an error) and cancels all other Completables.
static Completable	ambArray(CompletableSource... sources) Returns a Completable which terminates as soon as one of the source Completables terminates (normally or with an error) and cancels all other Completables.
final Completable	ambWith(CompletableSource other) Returns a Completable that emits the a terminated event of either this Completable or the other Completable whichever fires first.
final <T> Maybe<T>	andThen(MaybeSource<T> next) Returns a `Maybe` which will subscribe to this Completable and once that is completed then will subscribe to the `next` MaybeSource.
final <T> Flowable<T>	andThen(Publisher<T> next) Returns a Flowable which will subscribe to this Completable and once that is completed then will subscribe to the `next` Flowable.
final <T> Single<T>	andThen(SingleSource<T> next) Returns a Single which will subscribe to this Completable and once that is completed then will subscribe to the `next` SingleSource.
final <T> Observable<T>	andThen(ObservableSource<T> next) Returns an Observable which will subscribe to this Completable and once that is completed then will subscribe to the `next` ObservableSource.
final Completable	andThen(CompletableSource next) Returns a Completable that first runs this Completable and then the other completable.
final void	blockingAwait() Subscribes to and awaits the termination of this Completable instance in a blocking manner and rethrows any exception emitted.
final boolean	blockingAwait(long timeout, TimeUnit unit) Subscribes to and awaits the termination of this Completable instance in a blocking manner with a specific timeout and rethrows any exception emitted within the timeout window.
final Throwable	blockingGet() Subscribes to this Completable instance and blocks until it terminates, then returns null or the emitted exception if any.
final Throwable	blockingGet(long timeout, TimeUnit unit) Subscribes to this Completable instance and blocks until it terminates or the specified timeout elapses, then returns null for normal termination or the emitted exception if any.
final Completable	cache() Subscribes to this Completable only once, when the first CompletableObserver subscribes to the result Completable, caches its terminal event and relays/replays it to observers.
static Completable	complete() Returns a Completable instance that completes immediately when subscribed to.
final Completable	compose(CompletableTransformer transformer) Calls the given transformer function with this instance and returns the function's resulting Completable.
static Completable	concat(Publisher<? extends CompletableSource> sources) Returns a Completable which completes only when all sources complete, one after another.
static Completable	concat(Iterable<? extends CompletableSource> sources) Returns a Completable which completes only when all sources complete, one after another.
static Completable	concat(Publisher<? extends CompletableSource> sources, int prefetch) Returns a Completable which completes only when all sources complete, one after another.
static Completable	concatArray(CompletableSource... sources) Returns a Completable which completes only when all sources complete, one after another.
final Completable	concatWith(CompletableSource other) Concatenates this Completable with another Completable.
static Completable	create(CompletableOnSubscribe source) Provides an API (via a cold Completable) that bridges the reactive world with the callback-style world.
static Completable	defer(Callable<? extends CompletableSource> completableSupplier) Defers the subscription to a Completable instance returned by a supplier.
final Completable	delay(long delay, TimeUnit unit, Scheduler scheduler, boolean delayError) Returns a Completable which delays the emission of the completion event, and optionally the error as well, by the given time while running on the specified scheduler.
final Completable	delay(long delay, TimeUnit unit) Returns a Completable which delays the emission of the completion event by the given time.
final Completable	delay(long delay, TimeUnit unit, Scheduler scheduler) Returns a Completable which delays the emission of the completion event by the given time while running on the specified scheduler.
final Completable	doAfterTerminate(Action onAfterTerminate) Returns a Completable instance that calls the given onTerminate callback after this Completable completes normally or with an exception Scheduler: `doAfterTerminate` does not operate by default on a particular `Scheduler`.
final Completable	doFinally(Action onFinally) Calls the specified action after this Completable signals onError or onComplete or gets disposed by the downstream.
final Completable	doOnComplete(Action onComplete) Returns a Completable which calls the given onComplete callback if this Completable completes.
final Completable	doOnDispose(Action onDispose) Calls the shared `Action` if a CompletableObserver subscribed to the current Completable disposes the common Disposable it received via onSubscribe.
final Completable	doOnError(Consumer<? super Throwable> onError) Returns a Completable which calls the given onError callback if this Completable emits an error.
final Completable	doOnEvent(Consumer<? super Throwable> onEvent) Returns a Completable which calls the given onEvent callback with the (throwable) for an onError or (null) for an onComplete signal from this Completable before delivering said signal to the downstream.
final Completable	doOnSubscribe(Consumer<? super Disposable> onSubscribe) Returns a Completable instance that calls the given onSubscribe callback with the disposable that child subscribers receive on subscription.
final Completable	doOnTerminate(Action onTerminate) Returns a Completable instance that calls the given onTerminate callback just before this Completable completes normally or with an exception Scheduler: `doOnTerminate` does not operate by default on a particular `Scheduler`.
static Completable	error(Throwable error) Creates a Completable instance that emits the given Throwable exception to subscribers.
static Completable	error(Callable<? extends Throwable> errorSupplier) Creates a Completable which calls the given error supplier for each subscriber and emits its returned Throwable.
static Completable	fromAction(Action run) Returns a Completable instance that runs the given Action for each subscriber and emits either an unchecked exception or simply completes.
static Completable	fromCallable(Callable<?> callable) Returns a Completable which when subscribed, executes the callable function, ignores its normal result and emits onError or onComplete only.
static Completable	fromFuture(Future<?> future) Returns a Completable instance that reacts to the termination of the given Future in a blocking fashion.
static <T> Completable	fromObservable(ObservableSource<T> observable) Returns a Completable instance that subscribes to the given Observable, ignores all values and emits only the terminal event.
static <T> Completable	fromPublisher(Publisher<T> publisher) Returns a Completable instance that subscribes to the given publisher, ignores all values and emits only the terminal event.
static Completable	fromRunnable(Runnable run) Returns a Completable instance that runs the given Runnable for each subscriber and emits either its exception or simply completes.
static <T> Completable	fromSingle(SingleSource<T> single) Returns a Completable instance that when subscribed to, subscribes to the Single instance and emits a completion event if the single emits onSuccess or forwards any onError events.
final Completable	hide() Hides the identity of this Completable and its Disposable.
final Completable	lift(CompletableOperator onLift) Advanced use without safeguards: lifts a CompletableOperator transformation into the chain of Completables.
static Completable	merge(Iterable<? extends CompletableSource> sources) Returns a Completable instance that subscribes to all sources at once and completes only when all source Completables complete or one of them emits an error.
static Completable	merge(Publisher<? extends CompletableSource> sources, int maxConcurrency) Returns a Completable instance that keeps subscriptions to a limited number of sources at once and completes only when all source Completables complete or one of them emits an error.
static Completable	merge(Publisher<? extends CompletableSource> sources) Returns a Completable instance that subscribes to all sources at once and completes only when all source Completables complete or one of them emits an error.
static Completable	mergeArray(CompletableSource... sources) Returns a Completable instance that subscribes to all sources at once and completes only when all source Completables complete or one of them emits an error.
static Completable	mergeArrayDelayError(CompletableSource... sources) Returns a CompletableConsumable that subscribes to all Completables in the source array and delays any error emitted by either the sources observable or any of the inner Completables until all of them terminate in a way or another.
static Completable	mergeDelayError(Publisher<? extends CompletableSource> sources) Returns a Completable that subscribes to all Completables in the source sequence and delays any error emitted by either the sources observable or any of the inner Completables until all of them terminate in a way or another.
static Completable	mergeDelayError(Iterable<? extends CompletableSource> sources) Returns a Completable that subscribes to all Completables in the source sequence and delays any error emitted by either the sources observable or any of the inner Completables until all of them terminate in a way or another.
static Completable	mergeDelayError(Publisher<? extends CompletableSource> sources, int maxConcurrency) Returns a Completable that subscribes to a limited number of inner Completables at once in the source sequence and delays any error emitted by either the sources observable or any of the inner Completables until all of them terminate in a way or another.
final Completable	mergeWith(CompletableSource other) Returns a Completable which subscribes to this and the other Completable and completes when both of them complete or one emits an error.
static Completable	never() Returns a Completable that never calls onError or onComplete.
final Completable	observeOn(Scheduler scheduler) Returns a Completable which emits the terminal events from the thread of the specified scheduler.
final Completable	onErrorComplete(Predicate<? super Throwable> predicate) Returns a Completable instance that if this Completable emits an error and the predicate returns true, it will emit an onComplete and swallow the throwable.
final Completable	onErrorComplete() Returns a Completable instance that if this Completable emits an error, it will emit an onComplete and swallow the throwable.
final Completable	onErrorResumeNext(Function<? super Throwable, ? extends CompletableSource> errorMapper) Returns a Completable instance that when encounters an error from this Completable, calls the specified mapper function that returns another Completable instance for it and resumes the execution with it.
final Completable	repeat() Returns a Completable that repeatedly subscribes to this Completable until cancelled.
final Completable	repeat(long times) Returns a Completable that subscribes repeatedly at most the given times to this Completable.
final Completable	repeatUntil(BooleanSupplier stop) Returns a Completable that repeatedly subscribes to this Completable so long as the given stop supplier returns false.
final Completable	repeatWhen(Function<? super Flowable<Object>, ? extends Publisher<?>> handler) Returns a Completable instance that repeats when the Publisher returned by the handler emits an item or completes when this Publisher emits a completed event.
final Completable	retry(BiPredicate<? super Integer, ? super Throwable> predicate) Returns a Completable that retries this Completable in case of an error as long as the predicate returns true.
final Completable	retry(Predicate<? super Throwable> predicate) Returns a Completable that when this Completable emits an error, calls the given predicate with the latest exception to decide whether to resubscribe to this or not.
final Completable	retry() Returns a Completable that retries this Completable as long as it emits an onError event.
final Completable	retry(long times) Returns a Completable that when this Completable emits an error, retries at most the given number of times before giving up and emitting the last error.
final Completable	retryWhen(Function<? super Flowable<Throwable>, ? extends Publisher<?>> handler) Returns a Completable which given a Publisher and when this Completable emits an error, delivers that error through a Flowable and the Publisher should signal a value indicating a retry in response or a terminal event indicating a termination.
final <T> Observable<T>	startWith(Observable<T> other) Returns an Observable which first delivers the events of the other Observable then runs this CompletableConsumable.
final <T> Flowable<T>	startWith(Publisher<T> other) Returns a Flowable which first delivers the events of the other Publisher then runs this Completable.
final Completable	startWith(CompletableSource other) Returns a Completable which first runs the other Completable then this completable if the other completed normally.
final Disposable	subscribe(Action onComplete, Consumer<? super Throwable> onError) Subscribes to this Completable and calls back either the onError or onComplete functions.
final void	subscribe(CompletableObserver s) Subscribes the given CompletableObserver to this CompletableSource instance.
final Disposable	subscribe() Subscribes to this CompletableConsumable and returns a Disposable which can be used to cancel the subscription.
final Disposable	subscribe(Action onComplete) Subscribes to this Completable and calls the given Action when this Completable completes normally.
abstract void	subscribeActual(CompletableObserver s) Implement this to handle the incoming CompletableObserver and perform the business logic in your operator.
final Completable	subscribeOn(Scheduler scheduler) Returns a Completable which subscribes the child subscriber on the specified scheduler, making sure the subscription side-effects happen on that specific thread of the scheduler.
final <E extends CompletableObserver> E	subscribeWith(E observer) Subscribes a given CompletableObserver (subclass) to this Completable and returns the given CompletableObserver as is.
final TestObserver<Void>	test() Creates a TestObserver and subscribes it to this Completable.
final TestObserver<Void>	test(boolean cancelled) Creates a TestObserver optionally in cancelled state, then subscribes it to this Completable.
final Completable	timeout(long timeout, TimeUnit unit, Scheduler scheduler, CompletableSource other) Returns a Completable that runs this Completable and switches to the other Completable in case this Completable doesn't complete within the given time while "waiting" on the specified scheduler.
final Completable	timeout(long timeout, TimeUnit unit, CompletableSource other) Returns a Completable that runs this Completable and switches to the other Completable in case this Completable doesn't complete within the given time.
final Completable	timeout(long timeout, TimeUnit unit) Returns a Completable that runs this Completable and emits a TimeoutException in case this Completable doesn't complete within the given time.
final Completable	timeout(long timeout, TimeUnit unit, Scheduler scheduler) Returns a Completable that runs this Completable and emits a TimeoutException in case this Completable doesn't complete within the given time while "waiting" on the specified Scheduler.
static Completable	timer(long delay, TimeUnit unit) Returns a Completable instance that fires its onComplete event after the given delay elapsed.
static Completable	timer(long delay, TimeUnit unit, Scheduler scheduler) Returns a Completable instance that fires its onComplete event after the given delay elapsed by using the supplied scheduler.
final <U> U	to(Function<? super Completable, U> converter) Allows fluent conversion to another type via a function callback.
final <T> Flowable<T>	toFlowable() Returns a Flowable which when subscribed to subscribes to this Completable and relays the terminal events to the subscriber.
final <T> Maybe<T>	toMaybe() Converts this Completable into a `Maybe`.
final <T> Observable<T>	toObservable() Returns an Observable which when subscribed to subscribes to this Completable and relays the terminal events to the subscriber.
final <T> Single<T>	toSingle(Callable<? extends T> completionValueSupplier) Converts this Completable into a Single which when this Completable completes normally, calls the given supplier and emits its returned value through onSuccess.
final <T> Single<T>	toSingleDefault(T completionValue) Converts this Completable into a Single which when this Completable completes normally, emits the given value through onSuccess.
static Completable	unsafeCreate(CompletableSource source) Constructs a Completable instance by wrapping the given source callback without any safeguards; you should manage the lifecycle and response to downstream cancellation/dispose.
final Completable	unsubscribeOn(Scheduler scheduler) Returns a Completable which makes sure when a subscriber cancels the subscription, the dispose is called on the specified scheduler Scheduler: `unsubscribeOn` calls dispose() of the upstream on the `Scheduler` you specify.
static <R> Completable	using(Callable<R> resourceSupplier, Function<? super R, ? extends CompletableSource> completableFunction, Consumer<? super R> disposer, boolean eager) Returns a Completable instance which manages a resource along with a custom Completable instance while the subscription is active and performs eager or lazy resource disposition.
static <R> Completable	using(Callable<R> resourceSupplier, Function<? super R, ? extends CompletableSource> completableFunction, Consumer<? super R> disposer) Returns a Completable instance which manages a resource along with a custom Completable instance while the subscription is active.
static Completable	wrap(CompletableSource source) Wraps the given CompletableSource into a Completable if not already Completable.

From class java.lang.Object

From interface io.reactivex.CompletableObserver

From interface io.reactivex.CompletableSource

Public Methods

public static CompletableSubject create ()

Creates a fresh CompletableSubject.

Returns

the new CompletableSubject instance

public Throwable getThrowable ()

Returns the terminal error if this CompletableSubject has been terminated with an error, null otherwise.

Returns

the terminal error or null if not terminated or not with an error

public boolean hasComplete ()

Returns true if this CompletableSubject has been completed.

Returns

true if this CompletableSubject has been completed

public boolean hasObservers ()

Returns true if this CompletableSubject has observers.

Returns

true if this CompletableSubject has observers

public boolean hasThrowable ()

Returns true if this CompletableSubject has been terminated with an error.

Returns

true if this CompletableSubject has been terminated with an error

public void onComplete ()

Called once the deferred computation completes normally.

public void onError (Throwable e)

Called once if the deferred computation 'throws' an exception.

Parameters

e	the exception, not null.

public void onSubscribe (Disposable d)

Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.

Parameters

d	the Disposable instance to call dispose on for cancellation, not null

Protected Methods

protected void subscribeActual (CompletableObserver observer)

Implement this to handle the incoming CompletableObserver and perform the business logic in your operator.

Parameters

observer	the CompletableObserver instance, never null

Classes

CompletableSubject

Class Overview

Summary

Public Methods

public static CompletableSubject create ()

Returns

public Throwable getThrowable ()

Returns

public boolean hasComplete ()

Returns

public boolean hasObservers ()

Returns

public boolean hasThrowable ()

Returns

public void onComplete ()

public void onError (Throwable e)

Parameters

public void onSubscribe (Disposable d)

Parameters

Protected Methods

protected void subscribeActual (CompletableObserver observer)

Parameters