com.birbit.android.jobqueue.cachedQueue

Class CachedJobQueue

java.lang.Object

com.birbit.android.jobqueue.cachedQueue.CachedJobQueue

All Implemented Interfaces:

JobQueue

public class CachedJobQueue
extends java.lang.Object
implements JobQueue

a class that implements JobQueue interface, wraps another JobQueue and caches results to avoid unnecessary queries to wrapped JobQueue. does very basic caching but should be sufficient for most of the repeated cases element

Constructor Summary

Constructors

Constructor and Description
CachedJobQueue(JobQueue delegate)

Method Summary

Modifier and Type	Method and Description
void	clear() clear all jobs in the queue.
int	count() Returns the # of jobs that are waiting to be run
int	countReadyJobs(Constraint constraint) counts the # of jobs that can run now.
JobHolder	findJobById(java.lang.String id) returns the job with the given id if it exists in the queue
java.util.Set<JobHolder>	findJobs(Constraint constraint) Returns jobs that matches the given constraints
java.lang.Long	getNextJobDelayUntilNs(Constraint constraint) Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.
boolean	insert(JobHolder jobHolder) Inserts the given JobHolder.
boolean	insertOrReplace(JobHolder jobHolder) Does the same thing with insert but the only difference is that if job has an insertion ID, it should replace the existing one should also reset running session id to JobManager.NOT_RUNNING_SESSION_ID Is called when a job is re-added (due to exception during run)
JobHolder	nextJobAndIncRunCount(Constraint constraint) Returns the next available job in the data set It should also assign the sessionId as the RunningSessionId and persist that data if necessary.
void	onJobCancelled(JobHolder holder) Called when a job is cancelled by the user.
void	remove(JobHolder jobHolder) Removes the job from the data store.
void	substitute(JobHolder newJob, JobHolder oldJob) Remove the old job from the queue while inserting the new one.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedJobQueue

public CachedJobQueue(JobQueue delegate)

Method Detail

insert

public boolean insert(JobHolder jobHolder)

Description copied from interface: JobQueue

Inserts the given JobHolder.

Specified by:

insert in interface JobQueue

Parameters:

jobHolder - The JobHolder to be inserted

Returns:

True if job is added, false otherwise

insertOrReplace

public boolean insertOrReplace(JobHolder jobHolder)

Description copied from interface: JobQueue

Does the same thing with insert but the only difference is that if job has an insertion ID, it should replace the existing one should also reset running session id to JobManager.NOT_RUNNING_SESSION_ID Is called when a job is re-added (due to exception during run)

Specified by:

insertOrReplace in interface JobQueue

Parameters:

jobHolder - The JobHolder to be added

Returns:

True if job is added, false otherwise

substitute

public void substitute(JobHolder newJob,
                       JobHolder oldJob)

Description copied from interface: JobQueue

Remove the old job from the queue while inserting the new one.

Specified by:

substitute in interface JobQueue

Parameters:

newJob - To be inserted

oldJob - To be removed

remove

public void remove(JobHolder jobHolder)

Description copied from interface: JobQueue

Removes the job from the data store. Is called after a job is completed (or cancelled)

Specified by:

remove in interface JobQueue

Parameters:

jobHolder - The JobHolder to be removed

count

public int count()

Description copied from interface: JobQueue

Returns the # of jobs that are waiting to be run

Specified by:

count in interface JobQueue

Returns:

The number of jobs that are waiting in the queue

countReadyJobs

public int countReadyJobs(Constraint constraint)

Description copied from interface: JobQueue

counts the # of jobs that can run now. if there are more jobs from the same group, they are count as 1 since they cannot be run in parallel.

Exclude groups are guaranteed to be ordered in natural order.

Specified by:

countReadyJobs in interface JobQueue

Parameters:

constraint - The constraint to match the jobs

Returns:

The number of jobs that are ready to run

nextJobAndIncRunCount

public JobHolder nextJobAndIncRunCount(Constraint constraint)

Description copied from interface: JobQueue

Returns the next available job in the data set It should also assign the sessionId as the RunningSessionId and persist that data if necessary. It should filter out all running jobs and exclude groups are guaranteed to be ordered in natural order

Specified by:

nextJobAndIncRunCount in interface JobQueue

Parameters:

constraint - The constraint to match the job.

Returns:

The next job to be run that matches the constraint or null if there is no such job

getNextJobDelayUntilNs

public java.lang.Long getNextJobDelayUntilNs(Constraint constraint)

Description copied from interface: JobQueue

Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.

This method should check both delayed jobs and jobs that require network with a timeout.

Specified by:

getNextJobDelayUntilNs in interface JobQueue

Parameters:

constraint - The constraint to match the job.

Returns:

The time until next job is ready or null if there aren't any jobs matching the constraint

clear

public void clear()

Description copied from interface: JobQueue

clear all jobs in the queue. should probably be called when user logs out.

Specified by:

clear in interface JobQueue

findJobs

public java.util.Set<JobHolder> findJobs(Constraint constraint)

Description copied from interface: JobQueue

Returns jobs that matches the given constraints

Specified by:

findJobs in interface JobQueue

Parameters:

constraint - The constraint to match the job.

Returns:

The set of jobs that matches the given constraint

onJobCancelled

public void onJobCancelled(JobHolder holder)

Description copied from interface: JobQueue

Called when a job is cancelled by the user.

It is important to not return this job from queries anymore.

Specified by:

onJobCancelled in interface JobQueue

Parameters:

holder - The JobHolder that is being cancelled

findJobById

public JobHolder findJobById(java.lang.String id)

Description copied from interface: JobQueue

returns the job with the given id if it exists in the queue

Specified by:

findJobById in interface JobQueue

Parameters:

id - id of the job

Returns:

JobHolder with the given id or null if it does not exists