io.reactivex.observable.subjects

Class SingleSubject<T>

java.lang.Object

io.reactivex.observable.Single<T>

io.reactivex.observable.subjects.SingleSubject<T>

Type Parameters:

T - the value type received and emitted

All Implemented Interfaces:

SingleObserver<T>, SingleSource<T>

public final class SingleSubject<T>
extends Single<T>
implements SingleObserver<T>

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

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

The SingleSubject 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 <T> SingleSubject<T>	create() Creates a fresh SingleSubject.
java.lang.Throwable	getThrowable() Returns the terminal error if this SingleSubject has been terminated with an error, null otherwise.
T	getValue() Returns the success value if this SingleSubject was terminated with a success value.
boolean	hasObservers() Returns true if this SingleSubject has observers.
boolean	hasThrowable() Returns true if this SingleSubject has been terminated with an error.
boolean	hasValue() Returns true if this SingleSubject was terminated with a success value.
void	onError(java.lang.Throwable e) Notifies the SingleObserver that the Single has experienced an error condition.
void	onSubscribe(io.reactivex.common.Disposable d) Provides the SingleObserver with the means of cancelling (disposing) the connection (channel) with the Single in both synchronous (from within onSubscribe(Disposable) itself) and asynchronous manner.
void	onSuccess(T value) Notifies the SingleObserver with a single item and that the Single has finished sending push-based notifications.
protected void	subscribeActual(SingleObserver<? super T> observer) Override this method in subclasses to handle the incoming SingleObservers.

Methods inherited from class io.reactivex.observable.Single

amb, ambArray, ambWith, blockingGet, cache, cast, compose, concat, concat, concat, concat, concat, concat, concatArray, concatWith, contains, contains, create, defer, delay, delay, delaySubscription, delaySubscription, delaySubscription, delaySubscription, delaySubscription, doAfterSuccess, doAfterTerminate, doFinally, doOnDispose, doOnError, doOnEvent, doOnSubscribe, doOnSuccess, equals, error, error, filter, flatMap, flatMapCompletable, flatMapMaybe, flatMapObservable, flatMapObservableSource, flattenAsObservable, fromCallable, fromFuture, fromFuture, fromFuture, fromFuture, fromObservable, hide, just, lift, map, merge, merge, merge, merge, merge, merge, mergeWith, never, observeOn, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onErrorReturnItem, repeat, repeat, repeatUntil, repeatWhen, retry, retry, retry, retry, retryWhen, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, takeUntil, takeUntil, takeUntil, test, test, timeout, timeout, timeout, timeout, timer, timer, to, toCompletable, toFuture, toMaybe, toObservable, unsafeCreate, using, using, wrap, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipArray, zipWith

Methods inherited from class java.lang.Object

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

Method Detail

create

@CheckReturnValue
 @NonNull
public static <T> SingleSubject<T> create()

Creates a fresh SingleSubject.

Type Parameters:

T - the value type received and emitted

Returns:

the new SingleSubject instance

onSubscribe

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

Description copied from interface: SingleObserver

Provides the SingleObserver with the means of cancelling (disposing) the connection (channel) with the Single in both synchronous (from within onSubscribe(Disposable) itself) and asynchronous manner.

Specified by:

onSubscribe in interface SingleObserver<T>

Parameters:

d - the Disposable instance whose Disposable.dispose() can be called anytime to cancel the connection

onSuccess

public void onSuccess(@NonNull
                      T value)

Description copied from interface: SingleObserver

Notifies the SingleObserver with a single item and that the Single has finished sending push-based notifications.

The Single will not call this method if it calls SingleObserver.onError(java.lang.Throwable).

Specified by:

onSuccess in interface SingleObserver<T>

Parameters:

value - the item emitted by the Single

onError

public void onError(@NonNull
                    java.lang.Throwable e)

Description copied from interface: SingleObserver

Notifies the SingleObserver that the Single has experienced an error condition.

If the Single calls this method, it will not thereafter call SingleObserver.onSuccess(T).

Specified by:

onError in interface SingleObserver<T>

Parameters:

e - the exception encountered by the Single

subscribeActual

protected void subscribeActual(@NonNull
                               SingleObserver<? super T> observer)

Description copied from class: Single

Override this method in subclasses to handle the incoming SingleObservers.

Specified by:

subscribeActual in class Single<T>

Parameters:

observer - the SingleObserver to handle, not null

getValue

@Nullable
public T getValue()

Returns the success value if this SingleSubject was terminated with a success value.

Returns:

the success value or null

hasValue

public boolean hasValue()

Returns true if this SingleSubject was terminated with a success value.

Returns:

true if this SingleSubject was terminated with a success value

getThrowable

@Nullable
public java.lang.Throwable getThrowable()

Returns the terminal error if this SingleSubject 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 SingleSubject has been terminated with an error.

Returns:

true if this SingleSubject has been terminated with an error

hasObservers

public boolean hasObservers()

Returns true if this SingleSubject has observers.

Returns:

true if this SingleSubject has observers