com.birbit.android.jobqueue.callback

Interface JobManagerCallback

All Known Implementing Classes:

JobManagerCallbackAdapter

public interface JobManagerCallback

A callback class that you can attach to the JobManager to get notified as Jobs change states.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it decided not to run again via Job.shouldReRunOnThrowable(Throwable, int, int).
static int	RESULT_CANCEL_CANCELLED_WHILE_RUNNING Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it was cancelled via JobManager.cancelJobs(TagConstraint, String...) while it was running.
static int	RESULT_CANCEL_REACHED_RETRY_LIMIT Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it has reached its retry limit.
static int	RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because another job with the same single instance id was queued while it was running.
static int	RESULT_FAIL_WILL_RETRY Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and wanted to retry via Job.shouldReRunOnThrowable(Throwable, int, int).
static int	RESULT_SUCCEED Used in onJobRun(Job, int) when properly completes Job.onRun().

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.

Field Detail

RESULT_SUCCEED

static final int RESULT_SUCCEED

Used in onJobRun(Job, int) when properly completes Job.onRun().

See Also:

Constant Field Values

RESULT_CANCEL_REACHED_RETRY_LIMIT

static final int RESULT_CANCEL_REACHED_RETRY_LIMIT

Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it has reached its retry limit.

See Also:

Job.getRetryLimit(), Constant Field Values

RESULT_CANCEL_CANCELLED_WHILE_RUNNING

static final int RESULT_CANCEL_CANCELLED_WHILE_RUNNING

Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it was cancelled via JobManager.cancelJobs(TagConstraint, String...) while it was running.

See Also:

JobManager.cancelJobs(TagConstraint, String...), JobManager.cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...), Constant Field Values

RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING

static final int RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING

Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because another job with the same single instance id was queued while it was running.

See Also:

Job.getSingleInstanceId(), Constant Field Values

RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN

static final int RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN

Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it decided not to run again via Job.shouldReRunOnThrowable(Throwable, int, int).

See Also:

Constant Field Values

RESULT_FAIL_WILL_RETRY

static final int RESULT_FAIL_WILL_RETRY

Used in onJobRun(Job, int) when job throws an exception in Job.onRun() and wanted to retry via Job.shouldReRunOnThrowable(Throwable, int, int).

See Also:

Job.getRetryLimit(), Constant Field Values

Method Detail

onJobAdded

void onJobAdded(Job job)

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

Parameters:

job - The Job that was added to the JobManager.

onJobRun

void onJobRun(Job job,
              int resultCode)

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

Parameters:

job - The Job that did just run.

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

• RESULT_SUCCEED
• RESULT_CANCEL_REACHED_RETRY_LIMIT
• RESULT_CANCEL_CANCELLED_WHILE_RUNNING
• RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING
• RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN
• RESULT_FAIL_WILL_RETRY

onJobCancelled

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

Called when a job is cancelled.

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

void onDone(Job job)

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.

Parameters:

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

onAfterJobRun

void onAfterJobRun(Job job,
                   int resultCode)

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.

Parameters:

job - The Job that just onFinished a run call.

resultCode - The result of the run call.

See Also:

onJobRun(Job, int)