com.birbit.android.jobqueue.callback

Class JobManagerCallbackAdapter

java.lang.Object

com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter

All Implemented Interfaces:

JobManagerCallback

public class JobManagerCallbackAdapter
extends java.lang.Object
implements JobManagerCallback

An empty implementation of JobManagerCallback. You are advice to override this one instead so that if new methods are added to the interface, your code won't break.

Field Summary

Fields inherited from interface com.birbit.android.jobqueue.callback.JobManagerCallback

RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN, RESULT_CANCEL_CANCELLED_WHILE_RUNNING, RESULT_CANCEL_REACHED_RETRY_LIMIT, RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING, RESULT_FAIL_WILL_RETRY, RESULT_SUCCEED

Constructor Summary

Constructors

Constructor and Description
JobManagerCallbackAdapter()

Method Summary

Modifier and Type	Method and Description
void	onAfterJobRun(Job job, int resultCode) Called after a Job is run and its run result has been handled.
void	onDone(Job job) Called after a Job is removed from the JobManager.
void	onJobAdded(Job job) Called when a Job is added to the JobManager.
void	onJobCancelled(Job job, boolean byCancelRequest, java.lang.Throwable throwable) Called when a job is cancelled.
void	onJobRun(Job job, int resultCode) Called after a Job has been Run.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobManagerCallbackAdapter

public JobManagerCallbackAdapter()

Method Detail

onJobAdded

public void onJobAdded(Job job)

Description copied from interface: JobManagerCallback

Called when a Job is added to the JobManager. This method is called after Job's onAdded method is called.

Specified by:

onJobAdded in interface JobManagerCallback

Parameters:

job - The Job that was added to the JobManager.

onJobRun

public void onJobRun(Job job,
                     int resultCode)

Description copied from interface: JobManagerCallback

Called after a Job has been Run. Might be called multiple times if the Job runs multiple times (due to failures).

Specified by:

onJobRun in interface JobManagerCallback

Parameters:

job - The Job that did just run.

resultCode - The result of the Job.onRun(). It is one of:

• JobManagerCallback.RESULT_SUCCEED
• JobManagerCallback.RESULT_CANCEL_REACHED_RETRY_LIMIT
• JobManagerCallback.RESULT_CANCEL_CANCELLED_WHILE_RUNNING
• JobManagerCallback.RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING
• JobManagerCallback.RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN
• JobManagerCallback.RESULT_FAIL_WILL_RETRY

onJobCancelled

public void onJobCancelled(Job job,
                           boolean byCancelRequest,
                           java.lang.Throwable throwable)

Description copied from interface: JobManagerCallback

Called when a job is cancelled.

Specified by:

onJobCancelled in interface JobManagerCallback

Parameters:

job - The Job that was cancelled.

byCancelRequest - If true, the Job was cancelled in response to a JobManager.cancelJobs(TagConstraint, String...) request.

throwable - The exception that was thrown from the last execution of Job.onRun()

onDone

public void onDone(Job job)

Description copied from interface: JobManagerCallback

Called after a Job is removed from the JobManager. It might be cancelled or onFinished. This call is a good place to be sure that JobManager is done with the Job.

Specified by:

onDone in interface JobManagerCallback

Parameters:

job - The Job that was just removed from the JobManager.

onAfterJobRun

public void onAfterJobRun(Job job,
                          int resultCode)

Description copied from interface: JobManagerCallback

Called after a Job is run and its run result has been handled. For instance, if the Job is cancelled, this method is called after the job is removed from the queue.

Specified by:

onAfterJobRun in interface JobManagerCallback

Parameters:

job - The Job that just onFinished a run call.

resultCode - The result of the run call.

See Also:

JobManagerCallback.onJobRun(Job, int)