Package com.pranavpandey.android.dynamic.util.concurrent

Class DynamicRunnable<T,P,R>

java.lang.Object

com.pranavpandey.android.dynamic.util.concurrent.DynamicRunnable<T,P,R>

Type Parameters:

T - The type of the params.

P - The type of the progress.

R - The type of the result.

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DynamicTask

public abstract class DynamicRunnable<T,P,R>
extends Object
implements Runnable

Base class to receive the callback from an asynchronous work.

Constructor Summary

Constructors

Constructor	Description
DynamicRunnable()

Method Summary

Modifier and Type	Method	Description
abstract boolean	cancel(boolean mayInterruptIfRunning)	Attempts to cancel execution of this task.
protected abstract R	doInBackground(T params)	This method will be called for doing the background work.
abstract void	finish(DynamicResult<R> result)	This method will be called to handle the result returned by the task.
abstract boolean	isCancelled()	Returns true if this task was cancelled before it completed normally.
protected void	onCancelled()	Applications should preferably override onCancelled(DynamicResult).
protected void	onCancelled(DynamicResult<R> result)	Runs on the UI thread after cancel(boolean) is invoked and doInBackground(Object) has finished.
protected void	onPostExecute(DynamicResult<R> result)	This method will be called after completing the work.
protected void	onPreExecute()	This method will be called before doing the background work.
protected void	onProgressUpdate(DynamicResult<P> progress)	This method will be called on publishing the progress.
abstract DynamicResult<P>	publishProgress(DynamicResult<P> progress)	This method can be invoked from doInBackground(T) to publish updates on the UI thread while the background computation is still running.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Details

DynamicRunnable

public DynamicRunnable()

Method Details

onPreExecute

@MainThread
protected void onPreExecute()

This method will be called before doing the background work.

doInBackground

@WorkerThread
@Nullable
protected abstract R doInBackground(@Nullable
 T params)

This method will be called for doing the background work.

Parameters:

params - The optional parameters required for the work.

Returns:

The optional result object.

onProgressUpdate

@MainThread
protected void onProgressUpdate(@Nullable
 DynamicResult<P> progress)

This method will be called on publishing the progress.

Parameters:

progress - The progress returned by the work.

onPostExecute

@MainThread
protected void onPostExecute(@Nullable
 DynamicResult<R> result)

This method will be called after completing the work.

Parameters:

result - The result returned by the work.

publishProgress

@WorkerThread
@Nullable
public abstract DynamicResult<P> publishProgress(@Nullable
 DynamicResult<P> progress)

This method can be invoked from doInBackground(T) to publish updates on the UI thread while the background computation is still running. Each call to this method will trigger the execution of onProgressUpdate(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<P>) on the UI thread. onProgressUpdate(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<P>) will not be called if the task has been canceled.

Parameters:

progress - The progress result to update the UI with.

Returns:

The published result.

See Also:

• onProgressUpdate(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<P>)
• doInBackground(T)

finish

@MainThread
public abstract void finish(@Nullable
 DynamicResult<R> result)

This method will be called to handle the result returned by the task.

Parameters:

result - The result returned by the work.

onCancelled

@MainThread
protected void onCancelled(DynamicResult<R> result)

Runs on the UI thread after cancel(boolean) is invoked and doInBackground(Object) has finished.

The default implementation simply invokes onCancelled() and ignores the result. If you write your own implementation, do not call super.onCancelled(result).

Parameters:

result - The result, if any, computed in doInBackground(Object), can be null.

See Also:

• cancel(boolean)
• isCancelled()

onCancelled

@MainThread
protected void onCancelled()

Applications should preferably override onCancelled(DynamicResult). This method is invoked by the default implementation of onCancelled(DynamicResult).

The default version does nothing.

Runs on the UI thread after cancel(boolean) is invoked and doInBackground(Object) has finished.

See Also:

• onCancelled(DynamicResult)
• cancel(boolean)
• isCancelled()

isCancelled

public abstract boolean isCancelled()

Returns true if this task was cancelled before it completed normally. If you are calling cancel(boolean) on the task, the value returned by this method should be checked periodically from doInBackground(Object) to end the task as soon as possible.

Returns:

true if task was cancelled before it completed

See Also:

• cancel(boolean)

cancel

public abstract boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

Calling this method will result in onCancelled(DynamicResult) being invoked on the UI thread after doInBackground(Object) returns. Calling this method guarantees that onPostExecute(Object) is never subsequently invoked, even if cancel returns false, but onPostExecute(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<R>) has not yet run. To finish the task as early as possible, check isCancelled() periodically from doInBackground(Object).

This only requests cancellation. It never waits for a running background task to terminate, even if mayInterruptIfRunning is true.

Parameters:

mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete.

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

See Also:

• isCancelled()
• onCancelled(DynamicResult)