io.reactivex

Interface MaybeObserver

Type Parameters:

T - the type of item the MaybeObserver expects to observe

All Known Implementing Classes:

DisposableMaybeObserver, MaybeSubject, ResourceMaybeObserver, TestObserver

public interface MaybeObserver

Provides a mechanism for receiving push-based notification of a single value, an error or completion without any value.

When a MaybeObserver is subscribed to a MaybeSource through the MaybeSource.subscribe(MaybeObserver) method, the MaybeSource calls onSubscribe(Disposable) with a Disposable that allows disposing the sequence at any time. A well-behaved MaybeSource will call a MaybeObserver's onSuccess(Object), onError(Throwable) or onComplete() method exactly once as they are considered mutually exclusive terminal signals.

Calling the MaybeObserver's method must happen in a serialized fashion, that is, they must not be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must adhere to the following protocol:

    onSubscribe (onSuccess | onError | onComplete)?

Note that unlike with the Observable protocol, onComplete() is not called after the success item has been signalled via onSuccess(Object).

Subscribing a MaybeObserver to multiple MaybeSources is not recommended. If such reuse happens, it is the duty of the MaybeObserver implementation to be ready to receive multiple calls to its methods and ensure proper concurrent behavior of its business logic.

Calling onSubscribe(Disposable), onSuccess(Object) or onError(Throwable) with a null argument is forbidden.

The implementations of the onXXX methods should avoid throwing runtime exceptions other than the following cases:

• If the argument is null, the methods can throw a NullPointerException. Note though that RxJava prevents nulls to enter into the flow and thus there is generally no need to check for nulls in flows assembled from standard sources and intermediate operators.
• If there is a fatal error (such as VirtualMachineError).

Since:

2.0

See Also:

ReactiveX documentation: Observable

Method Summary

Modifier and Type	Method and Description
void	onComplete() Called once the deferred computation completes normally.
void	onError(Throwable e) Notifies the MaybeObserver that the Maybe has experienced an error condition.
void	onSubscribe(Disposable d) Provides the MaybeObserver with the means of cancelling (disposing) the connection (channel) with the Maybe in both synchronous (from within onSubscribe(Disposable) itself) and asynchronous manner.
void	onSuccess(T t) Notifies the MaybeObserver with one item and that the Maybe has finished sending push-based notifications.

Method Detail

onSubscribe

void onSubscribe(@NonNull
                 Disposable d)

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

Parameters:

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

onSuccess

void onSuccess(@NonNull
               T t)

Notifies the MaybeObserver with one item and that the Maybe has finished sending push-based notifications.

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

Parameters:

t - the item emitted by the Maybe

onError

void onError(@NonNull
             Throwable e)

Notifies the MaybeObserver that the Maybe has experienced an error condition.

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

Parameters:

e - the exception encountered by the Maybe

onComplete

void onComplete()

Called once the deferred computation completes normally.