io.reactivex.observers

Class ResourceCompletableObserver

java.lang.Object

io.reactivex.observers.ResourceCompletableObserver

All Implemented Interfaces:

CompletableObserver, Disposable

public abstract class ResourceCompletableObserver
extends java.lang.Object
implements CompletableObserver, Disposable

An abstract CompletableObserver that allows asynchronous cancellation of its subscription and associated resources.

All pre-implemented final methods are thread-safe.

Constructor Summary

Constructors

Constructor and Description
ResourceCompletableObserver()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Disposable resource) Adds a resource to this ResourceObserver.
void	dispose() Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any).
boolean	isDisposed() Returns true if this ResourceObserver has been disposed/cancelled.
protected void	onStart() Called once the upstream sets a Subscription on this ResourceObserver.
void	onSubscribe(Disposable s) Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.CompletableObserver

onComplete, onError

Constructor Detail

ResourceCompletableObserver

public ResourceCompletableObserver()

Method Detail

add

public final void add(Disposable resource)

Adds a resource to this ResourceObserver.

Parameters:

resource - the resource to add

Throws:

java.lang.NullPointerException - if resource is null

onSubscribe

public final void onSubscribe(Disposable s)

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:

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

onStart

protected void onStart()

Called once the upstream sets a Subscription on this ResourceObserver.

You can perform initialization at this moment. The default implementation does nothing.

dispose

public final void dispose()

Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any).

This method can be called before the upstream calls onSubscribe at which case the main Disposable will be immediately disposed.

Specified by:

dispose in interface Disposable

isDisposed

public final boolean isDisposed()

Returns true if this ResourceObserver has been disposed/cancelled.

Specified by:

isDisposed in interface Disposable

Returns:

true if this ResourceObserver has been disposed/cancelled