com.birbit.android.jobqueue

Class RetryConstraint

java.lang.Object

com.birbit.android.jobqueue.RetryConstraint

public class RetryConstraint
extends java.lang.Object

Created by Job.shouldReRunOnThrowable(Throwable, int, int).

This object keeps additional data about handling job failures. You can simply use RETRY or CANCEL if you just want to retry or cancel a job. Alternatively, you can create your own instance where you can add a delay setNewDelayInMs(Long) or change Job's prioritiy setNewPriority(Integer).

A common use case is exponentially backing off a Job and you can use createExponentialBackoff(int, long) method to do that.

Field Summary

Fields

Modifier and Type	Field and Description
static RetryConstraint	CANCEL
static RetryConstraint	RETRY

Constructor Summary

Constructors

Constructor and Description
RetryConstraint(boolean retry)

Method Summary

Modifier and Type	Method and Description
static RetryConstraint	createExponentialBackoff(int runCount, long initialBackOffInMs) Creates a response that will exponentially back off the job.
java.lang.Long	getNewDelayInMs()
java.lang.Integer	getNewPriority()
void	setApplyNewDelayToGroup(boolean applyDelayToGroup) Sets whether the delay in the constraint should be applied to the whole group.
void	setNewDelayInMs(java.lang.Long newDelayInMs) Sets a timeout until the Job is tried again.
void	setNewPriority(java.lang.Integer newPriority) Updates the Job's priority.
void	setRetry(boolean retry) Set whether the Job should be run again or cancelled.
boolean	shouldRetry()
boolean	willApplyNewDelayToGroup() Returns whether the delay in this retry constraint will be applied to all jobs in this group.

Methods inherited from class java.lang.Object

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

Field Detail

RETRY

public static final RetryConstraint RETRY

CANCEL

public static final RetryConstraint CANCEL

Constructor Detail

RetryConstraint

public RetryConstraint(boolean retry)

Method Detail

shouldRetry

public boolean shouldRetry()

setRetry

public void setRetry(boolean retry)

Set whether the Job should be run again or cancelled.

Parameters:

retry - True if job should be retried, false if it should be cancelled

getNewDelayInMs

public java.lang.Long getNewDelayInMs()

setNewDelayInMs

public void setNewDelayInMs(java.lang.Long newDelayInMs)

Sets a timeout until the Job is tried again.

Parameters:

newDelayInMs - The new delay in Ms from now before retrying the job

getNewPriority

public java.lang.Integer getNewPriority()

setNewPriority

public void setNewPriority(java.lang.Integer newPriority)

Updates the Job's priority.

Parameters:

newPriority - Gives a new priority to the job

createExponentialBackoff

public static RetryConstraint createExponentialBackoff(int runCount,
                                                       long initialBackOffInMs)

Creates a response that will exponentially back off the job.

Parameters:

runCount - The run count that was passed to Job.shouldReRunOnThrowable(Throwable, int, int)

initialBackOffInMs - The initial back off time. This will be the back off for the inital run and then it will exponentially grow from this number.

Returns:

A RetryContraint that will report exponential back off.

setApplyNewDelayToGroup

public void setApplyNewDelayToGroup(boolean applyDelayToGroup)

Sets whether the delay in the constraint should be applied to the whole group.

Note that the delay will effect any Job that is added after this call until the delay ends. This will ensure that the Job execution order will be preserved.

If the job does not have a group id (Job.getRunGroupId(), calling this method has no effect.

The group delay is global so even after you cancel the jobs, it will still affect the group until delay times out.

Parameters:

applyDelayToGroup - Sets whether the delay should be applied to all jobs in this group.

willApplyNewDelayToGroup

public boolean willApplyNewDelayToGroup()

Returns whether the delay in this retry constraint will be applied to all jobs in this group.

Returns:

Whether the delay will be applied to all jobs in this group or not. Defaults to false.