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

Class DynamicTask<T,P,R>

java.lang.Object

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

com.pranavpandey.android.dynamic.util.concurrent.DynamicTask<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:

java.lang.Runnable

Direct Known Subclasses:

ContextTask, FileDeleteTask

public abstract class DynamicTask<T,P,R>
extends DynamicRunnable<T,P,R>

Base class to represent Runnable according to the DynamicRunnable.

Constructor Summary

Constructors

Constructor	Description
DynamicTask()	Constructor to initialize an object of this class.
DynamicTask(android.os.Looper looper)	Constructor to initialize an object of this class.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	Attempts to cancel execution of this task.
DynamicTask<T,P,R>	execute()	Executes the task with the default executor and null parameters.
DynamicTask<T,P,R>	execute(T params)	Executes the task with the supplied parameters.
DynamicTask<T,P,R>	executeOnExecutor(java.util.concurrent.Executor executor)	Executes the task on the supplied executor.
DynamicTask<T,P,R>	executeOnExecutor(java.util.concurrent.Executor executor, T params)	Executes the task on the supplied executor.
void	finish(DynamicResult<R> result)	This method will be called to handle the result returned by the task.
DynamicResult<R>	get()	Waits if necessary for the computation to complete, and then retrieves its result.
DynamicResult<R>	get(long timeout, java.util.concurrent.TimeUnit unit)	Waits if necessary for at most the given time for the computation to complete, and then retrieves its result.
boolean	getBooleanResult(DynamicResult<R> result)	Returns the unboxed boolean value from the Boolean result.
DynamicHandler<P,R>	getHandler()	Returns the thread handler used by this task.
DynamicStatus	getStatus()	Returns the current status of this task.
boolean	isCancelled()	Returns true if this task was cancelled before it completed normally.
DynamicResult<P>	publishProgress(DynamicResult<P> progress)	This method can be invoked from DynamicRunnable.doInBackground(T) to publish updates on the UI thread while the background computation is still running.
void	run()

Methods inherited from class com.pranavpandey.android.dynamic.util.concurrent.DynamicRunnable

doInBackground, onCancelled, onCancelled, onPostExecute, onPreExecute, onProgressUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicTask

public DynamicTask()

Constructor to initialize an object of this class.

DynamicTask

public DynamicTask(@NonNull
                   android.os.Looper looper)

Constructor to initialize an object of this class.

Parameters:

looper - The looper to be used.

Method Detail

getHandler

@NonNull
public DynamicHandler<P,R> getHandler()

Returns the thread handler used by this task.

Returns:

The thread handler used by this task.

getBooleanResult

public boolean getBooleanResult(@Nullable
                                DynamicResult<R> result)

Returns the unboxed boolean value from the Boolean result.

Parameters:

result - The Boolean result to be unboxed.

Returns:

The unboxed boolean value from the Boolean result.

getStatus

@NonNull
public final DynamicStatus getStatus()

Returns the current status of this task.

Returns:

The current status of this task.

get

@Nullable
public final DynamicResult<R> get()
                           throws java.lang.InterruptedException,
                                  java.util.concurrent.ExecutionException

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:

The computed result.

Throws:

java.util.concurrent.CancellationException - If the computation was cancelled.

java.util.concurrent.ExecutionException - If the computation threw an exception.

java.lang.InterruptedException - If the current thread was interrupted while waiting.

get

@Nullable
public final DynamicResult<R> get(long timeout,
                                  java.util.concurrent.TimeUnit unit)
                           throws java.lang.InterruptedException,
                                  java.util.concurrent.ExecutionException,
                                  java.util.concurrent.TimeoutException

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result.

Parameters:

timeout - Time to wait before cancelling the operation.

unit - The time unit for the timeout.

Returns:

The computed result.

Throws:

java.util.concurrent.CancellationException - If the computation was cancelled.

java.util.concurrent.ExecutionException - If the computation threw an exception.

java.lang.InterruptedException - If the current thread was interrupted while waiting.

java.util.concurrent.TimeoutException - If the wait timed out.

run

public void run()

publishProgress

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

Description copied from class: DynamicRunnable

This method can be invoked from DynamicRunnable.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 DynamicRunnable.onProgressUpdate(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<P>) on the UI thread. DynamicRunnable.onProgressUpdate(com.pranavpandey.android.dynamic.util.concurrent.DynamicResult<P>) will not be called if the task has been canceled.

Specified by:

publishProgress in class DynamicRunnable<T,P,R>

Parameters:

progress - The progress result to update the UI with.

Returns:

The published result.

See Also:

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

finish

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

Description copied from class: DynamicRunnable

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

Specified by:

finish in class DynamicRunnable<T,P,R>

Parameters:

result - The result returned by the work.

isCancelled

public final boolean isCancelled()

Description copied from class: DynamicRunnable

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

Specified by:

isCancelled in class DynamicRunnable<T,P,R>

Returns:

true if task was cancelled before it completed

See Also:

DynamicRunnable.cancel(boolean)

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Description copied from class: DynamicRunnable

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

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

Specified by:

cancel in class DynamicRunnable<T,P,R>

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:

DynamicRunnable.isCancelled(), DynamicRunnable.onCancelled(DynamicResult)

executeOnExecutor

@MainThread
@NonNull
public final DynamicTask<T,P,R> executeOnExecutor(@NonNull
                                                              java.util.concurrent.Executor executor,
                                                              @Nullable
                                                              T params)

Executes the task on the supplied executor.

Parameters:

executor - The executor to execute the task.

params - The optional parameters for the task.

Returns:

The instance of the executed task.

executeOnExecutor

@MainThread
@NonNull
public final DynamicTask<T,P,R> executeOnExecutor(@NonNull
                                                              java.util.concurrent.Executor executor)

Executes the task on the supplied executor.

Parameters:

executor - The executor to execute the task.

Returns:

The instance of the executed task.

execute

@MainThread
@NonNull
public final DynamicTask<T,P,R> execute(@Nullable
                                                    T params)

Executes the task with the supplied parameters.

Parameters:

params - The parameters for the task.

Returns:

The instance of the executed task.

See Also:

executeOnExecutor(Executor, Object), DynamicConcurrent.getThreadPoolExecutor()

execute

@MainThread
@NonNull
public final DynamicTask<T,P,R> execute()

Executes the task with the default executor and null parameters.

Returns:

The instance of the executed task.

See Also:

execute(Object), DynamicConcurrent.getThreadPoolExecutor()