io.reactivex.observers

Class ResourceObserver<T>

java.lang.Object

io.reactivex.observers.ResourceObserver<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

Disposable, Observer<T>

public abstract class ResourceObserver<T>
extends java.lang.Object
implements Observer<T>, Disposable

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

All pre-implemented final methods are thread-safe.

Constructor Summary

Constructors

Constructor and Description
ResourceObserver()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Disposable resource) Adds a resource to this ResourceObserver.
protected void	cancel() Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any).
void	dispose() Dispose the resource, the operation should be idempotent.
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) Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.Observer

onComplete, onError, onNext

Constructor Detail

ResourceObserver

public ResourceObserver()

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: Observer

Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.

Specified by:

onSubscribe in interface Observer<T>

Parameters:

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

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.

cancel

protected final void cancel()

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.

dispose

public final void dispose()

Description copied from interface: Disposable

Dispose the resource, the operation should be idempotent.

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