com.alexvasilkov.android.commons.tasks

Class BackgroundTask<P>

java.lang.Object

com.alexvasilkov.android.commons.tasks.BackgroundTask<P>

Direct Known Subclasses:

EventsTask

public abstract class BackgroundTask<P>
extends java.lang.Object

Helper class that will call regular AsyncTask and store caller (parent object) into WeakReference. All derived inner classes should be marked as static in most cases to not leak any Activities or Fragments

Constructor Summary

Constructors

Constructor and Description
BackgroundTask(P parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(boolean mayInterruptIfRunning)
protected abstract void	doTask()
void	exec()
protected void	onTaskEnded(P parent)
protected void	onTaskFail(P parent, java.lang.Exception e)
protected void	onTaskProgress(P parent)
protected void	onTaskStarted(P parent)
protected void	onTaskSuccess(P parent)
protected void	publishTaskProgress() Calls AsyncTask.publishProgress() method.
protected void	setSkipCallbacksIfParentIsNull(boolean skip)

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundTask

public BackgroundTask(P parent)

Parameters:

parent - Parent object (i.e. Activity or Fragment) to be passed to task's lyfecycle methods (onTaskStarted, onTaskSuccess, onTaskFail or onTaskEnded)

Method Detail

onTaskStarted

protected void onTaskStarted(P parent)

doTask

protected abstract void doTask()
                        throws java.lang.Exception

Throws:

java.lang.Exception

setSkipCallbacksIfParentIsNull

protected void setSkipCallbacksIfParentIsNull(boolean skip)

Parameters:

skip - Parent object is saved into WeakReference so it can be erased and we won't be able to pass it to task's lyfecycle methods. Default behavior is to skip calling these methods if parent object is null to prevent NPE, but you can change this if you must be sure that all callback methods are always called.

publishTaskProgress

protected void publishTaskProgress()

Calls AsyncTask.publishProgress() method. Corresponding callback method is onTaskProgress.
Should only be called from doTask method.

onTaskProgress

protected void onTaskProgress(P parent)

onTaskSuccess

protected void onTaskSuccess(P parent)

onTaskFail

protected void onTaskFail(P parent,
              java.lang.Exception e)

onTaskEnded

protected void onTaskEnded(P parent)

exec

public void exec()

cancel

public void cancel(boolean mayInterruptIfRunning)