io.divide.shared.file

Class QueuedWork

java.lang.Object

io.divide.shared.file.QueuedWork

public class QueuedWork
extends java.lang.Object

Internal utility class to keep track of process-global work that's outstanding and hasn't been finished yet. This was created for writing SharedPreference edits out asynchronously so we'd have a mechanism to wait for the writes in Activity.onPause and similar places, but we may use this mechanism for other things in the future.

Constructor Summary

Constructors

Constructor and Description
QueuedWork()

Method Summary

Methods

Modifier and Type	Method and Description
static void	add(java.lang.Runnable finisher) Add a runnable to finish (or wait for) a deferred operation started in this context earlier.
static boolean	hasPendingWork() Returns true if there is pending work to be done.
static void	remove(java.lang.Runnable finisher)
static java.util.concurrent.ExecutorService	singleThreadExecutor() Returns a single-thread Executor shared by the entire process, creating it if necessary.
static void	waitToFinish() Finishes or waits for async operations to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuedWork

public QueuedWork()

Method Detail

singleThreadExecutor

public static java.util.concurrent.ExecutorService singleThreadExecutor()

Returns a single-thread Executor shared by the entire process, creating it if necessary.

add

public static void add(java.lang.Runnable finisher)

Add a runnable to finish (or wait for) a deferred operation started in this context earlier. Typically finished by e.g. an Activity#onPause. Used by SharedPreferences$Editor#startCommit(). Note that this doesn't actually start it running. This is just a scratch set for callers doing async work to keep updated with what's in-flight. In the common case, caller code (e.g. SharedPreferences) will pretty quickly call remove() after an add(). The only time these Runnables are run is from waitToFinish(), below.

remove

public static void remove(java.lang.Runnable finisher)

waitToFinish

public static void waitToFinish()

Finishes or waits for async operations to complete. (e.g. SharedPreferences$Editor#startCommit writes) Is called from the Activity base class's onPause(), after BroadcastReceiver's onReceive, after Service command handling, etc. (so async work is never lost)

hasPendingWork

public static boolean hasPendingWork()

Returns true if there is pending work to be done. Note that the result is out of data as soon as you receive it, so be careful how you use it.