io.reactivex.android

Class MainThreadDisposable

java.lang.Object

io.reactivex.android.MainThreadDisposable

All Implemented Interfaces:

Disposable

public abstract class MainThreadDisposable
extends java.lang.Object
implements Disposable

A disposable which ensures its dispose action is executed on the main thread. When unsubscription occurs on a different thread than the main thread, the action is posted to run on the main thread as soon as possible.

Instances of this class are useful in creating observables which interact with APIs that can only be used on the main thread, such as UI objects.

A convenience method is also provided for validating whether code is being called on the main thread. Calls to this method along with instances of this class are commonly used when creating custom observables using the following pattern:

 @Override public void subscribe(Observer o) {
   MainThreadDisposable.verifyMainThread();

   // TODO setup behavior

    o.onSubscribe(new MainThreadDisposable() {
     @Override protected void onDispose() {
       // TODO undo behavior
     }
   });
 }
 

Constructor Summary

Constructors

Constructor and Description
MainThreadDisposable()

Method Summary

Modifier and Type	Method and Description
void	dispose()
boolean	isDisposed()
protected abstract void	onDispose()
static void	verifyMainThread() Verify that the calling thread is the Android main thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

MainThreadDisposable

public MainThreadDisposable()

Method Detail

verifyMainThread

public static void verifyMainThread()

Verify that the calling thread is the Android main thread.

Calls to this method are usually preconditions for subscription behavior which instances of this class later undo. See the class documentation for an example.

Throws:

java.lang.IllegalStateException - when called from any other thread.

isDisposed

public final boolean isDisposed()

Specified by:

isDisposed in interface Disposable

dispose

public final void dispose()

Specified by:

dispose in interface Disposable

onDispose

protected abstract void onDispose()