com.facebook.stetho.common

Interface ThreadBound

All Known Subinterfaces:

Descriptor.Host, DocumentProvider, DocumentProviderFactory, NodeDescriptor

All Known Implementing Classes:

AbstractChainedDescriptor, AndroidDocumentProviderFactory, Descriptor, Document, ObjectDescriptor, ThreadBoundProxy

public interface ThreadBound

Implemented by an object whose methods must be called on a specific thread. If a method is called from a disallowed thread then IllegalStateException will be thrown. To marshal a call to the correct thread, you can use postAndWait(UncheckedCallable) or postAndWait(Runnable), both of which complete synchronously.

Method Summary

Modifier and Type	Method and Description
boolean	checkThreadAccess() Checks whether the current thread has access to this object.
void	postAndWait(java.lang.Runnable r) Synchronously executes a Runnable on the thread that this object is bound to.
<V> V	postAndWait(UncheckedCallable<V> c) Synchronously executes an UncheckedCallable on the thread that this object is bound to, and returns its result.
void	postDelayed(java.lang.Runnable r, long delayMillis) Asynchronously executes a Runnable on the thread that this object is bound to after the specified delay.
void	removeCallbacks(java.lang.Runnable r) Removes any pending posts of the given Runnable that are in the queue.
void	verifyThreadAccess() Enforces that the current thread has access to this object.

Method Detail

checkThreadAccess

boolean checkThreadAccess()

Checks whether the current thread has access to this object.

Returns:

true if this thread has access to this object; otherwise false

verifyThreadAccess

void verifyThreadAccess()

Enforces that the current thread has access to this object.

Throws:

java.lang.IllegalStateException - if the current thread does not have access to this object

postAndWait

<V> V postAndWait(UncheckedCallable<V> c)

Synchronously executes an UncheckedCallable on the thread that this object is bound to, and returns its result.

Type Parameters:

V - the return type of the UncheckedCallable

Parameters:

c - the UncheckedCallable to execute

Returns:

the return value from UncheckedCallable.call()

Throws:

java.lang.RuntimeException - if the UncheckedCallable could not be executed (the cause will be null), or if UncheckedCallable.call() threw an exception (the cause will be the exception that it threw).

postAndWait

void postAndWait(java.lang.Runnable r)

Synchronously executes a Runnable on the thread that this object is bound to.

Parameters:

r - the Runnable to execute

Throws:

java.lang.RuntimeException - if the Runnable could not be executed (the cause will be null), or if Runnable.run() threw an exception (the cause will be the exception that it threw).

postDelayed

void postDelayed(java.lang.Runnable r,
                 long delayMillis)

Asynchronously executes a Runnable on the thread that this object is bound to after the specified delay.

Parameters:

r - the Runnable to execute

delayMillis - The delay (in milliseconds) until the Runnable will be executed.

Throws:

java.lang.RuntimeException - if the Runnable could not be enqueued.

removeCallbacks

void removeCallbacks(java.lang.Runnable r)

Removes any pending posts of the given Runnable that are in the queue.

Parameters:

r - the Runnable to remove from the queue