io.reactivex.observable.subjects

Class CompletableSubject

java.lang.Object

io.reactivex.observable.Completable

io.reactivex.observable.subjects.CompletableSubject

All Implemented Interfaces:

CompletableObserver, CompletableSource

public final class CompletableSubject
extends Completable
implements CompletableObserver

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).

Since:

2.0.5 - experimental

Method Summary

Modifier and Type	Method and Description
static CompletableSubject	create() Creates a fresh CompletableSubject.
java.lang.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(java.lang.Throwable e) Called once if the deferred computation 'throws' an exception.
void	onSubscribe(io.reactivex.common.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 void	subscribeActual(CompletableObserver observer) Implement this to handle the incoming CompletableObserver and perform the business logic in your operator.

Methods inherited from class io.reactivex.observable.Completable

amb, ambArray, ambWith, andThen, andThen, andThen, andThen, blockingAwait, blockingAwait, blockingGet, blockingGet, cache, complete, compose, concat, concat, concat, concatArray, concatWith, create, defer, delay, delay, delay, doAfterTerminate, doFinally, doOnComplete, doOnDispose, doOnError, doOnEvent, doOnSubscribe, doOnTerminate, error, error, fromAction, fromCallable, fromFuture, fromObservable, fromRunnable, fromSingle, hide, lift, merge, merge, merge, mergeArray, mergeArrayDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, never, observeOn, onErrorComplete, onErrorComplete, onErrorResumeNext, repeat, repeat, repeatUntil, repeatWhen, retry, retry, retry, retry, retryWhen, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, test, test, timeout, timeout, timeout, timeout, timer, timer, to, toMaybe, toObservable, toSingle, toSingleDefault, unsafeCreate, unsubscribeOn, using, using, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@CheckReturnValue
public static CompletableSubject create()

Creates a fresh CompletableSubject.

Returns:

the new CompletableSubject instance

onSubscribe

public void onSubscribe(io.reactivex.common.Disposable d)

Description copied from interface: CompletableObserver

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

Specified by:

onSubscribe in interface CompletableObserver

Parameters:

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

onError

public void onError(java.lang.Throwable e)

Description copied from interface: CompletableObserver

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

Specified by:

onError in interface CompletableObserver

Parameters:

e - the exception, not null.

onComplete

public void onComplete()

Description copied from interface: CompletableObserver

Called once the deferred computation completes normally.

Specified by:

onComplete in interface CompletableObserver

subscribeActual

protected void subscribeActual(CompletableObserver observer)

Description copied from class: Completable

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

Specified by:

subscribeActual in class Completable

Parameters:

observer - the CompletableObserver instance, never null

getThrowable

public java.lang.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

hasThrowable

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

hasComplete

public boolean hasComplete()

Returns true if this CompletableSubject has been completed.

Returns:

true if this CompletableSubject has been completed

hasObservers

public boolean hasObservers()

Returns true if this CompletableSubject has observers.

Returns:

true if this CompletableSubject has observers