Index (jobqueue API)

A B C D E F G H I J L M N O P Q R S T U V W

A

ACTIVE_CONSUMER_COUNT - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
add(String) - Method in class com.birbit.android.jobqueue.RunningJobSet
addCallback(JobManagerCallback) - Method in class com.birbit.android.jobqueue.JobManager: Adds a JobManagerCallback to observe this JobManager.
addGroupUntil(String, long) - Method in class com.birbit.android.jobqueue.RunningJobSet
addJob(Job) - Method in class com.birbit.android.jobqueue.JobManager: Adds the Job to the JobManager and waits until the add is handled.
addJobInBackground(Job) - Method in class com.birbit.android.jobqueue.JobManager: Adds a Job to the JobManager.
addJobInBackground(Job, AsyncAddCallback) - Method in class com.birbit.android.jobqueue.JobManager: Adds a Job in a background thread and calls the provided callback once the Job is added to the JobManager.
AddJobMessage - Class in com.birbit.android.jobqueue.messaging.message
AddJobMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.AddJobMessage
addTags(String...) - Method in class com.birbit.android.jobqueue.Params: Attaches given tags to the Job.
args - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
assertNotCancelled() - Method in class com.birbit.android.jobqueue.Job: Convenience method that checks if job is cancelled and throws a RuntimeException if it is cancelled.
AsyncAddCallback - Interface in com.birbit.android.jobqueue: If you are adding the job via the async adder, you can provide a callback method to confirm when it was added.

B

BatchingScheduler - Class in com.birbit.android.jobqueue: JobManager calls scheduler every time it receives some job that can use the Scheduler APIs.
BatchingScheduler(Scheduler, Timer) - Constructor for class com.birbit.android.jobqueue.BatchingScheduler
batchSchedulerRequests() - Method in class com.birbit.android.jobqueue.config.Configuration
build() - Method in class com.birbit.android.jobqueue.config.Configuration.Builder
build() - Method in class com.birbit.android.jobqueue.JobHolder.Builder
Builder(Context) - Constructor for class com.birbit.android.jobqueue.config.Configuration.Builder
Builder() - Constructor for class com.birbit.android.jobqueue.JobHolder.Builder

C

CachedJobQueue - Class in com.birbit.android.jobqueue.cachedQueue: a class that implements JobQueue interface, wraps another JobQueue and caches results to avoid unnecessary queries to wrapped JobQueue.
CachedJobQueue(JobQueue) - Constructor for class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
cacheKey - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
CallbackManager - Class in com.birbit.android.jobqueue: Handles callbacks to user code.
CallbackManager(MessageFactory, Timer) - Constructor for class com.birbit.android.jobqueue.CallbackManager
CallbackMessage - Class in com.birbit.android.jobqueue.messaging.message: Used for external callbacks to user code
CallbackMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.CallbackMessage
CANCEL - Static variable in class com.birbit.android.jobqueue.RetryConstraint
cancelAll() - Method in class com.birbit.android.jobqueue.BatchingScheduler
cancelAll() - Method in class com.birbit.android.jobqueue.scheduling.Scheduler: When called, should cancel all pending jobs
cancelJobs(TagConstraint, String...) - Method in class com.birbit.android.jobqueue.JobManager: Cancels jobs that match the given criteria.
cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...) - Method in class com.birbit.android.jobqueue.JobManager: Cancels the Jobs that match the given criteria.
CANCELLED_VIA_SHOULD_RE_RUN - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used 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).
CANCELLED_WHILE_RUNNING - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used 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.
CancelMessage - Class in com.birbit.android.jobqueue.messaging.message
CancelMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.CancelMessage
cancelMessages(MessagePredicate) - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
cancelMessages(MessagePredicate) - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
cancelMessages(MessagePredicate) - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
CancelReason - Annotation Type in com.birbit.android.jobqueue: A list of possible reasons why a Job was cancelled.
CancelResult - Class in com.birbit.android.jobqueue: This class holds the result of a cancel request via JobManager.cancelJobs(TagConstraint, String...) or JobManager.cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...).
CancelResult() - Constructor for class com.birbit.android.jobqueue.CancelResult
CancelResult(Collection<Job>, Collection<Job>) - Constructor for class com.birbit.android.jobqueue.CancelResult
CancelResult.AsyncCancelCallback - Interface in com.birbit.android.jobqueue
CancelResultMessage - Class in com.birbit.android.jobqueue.messaging.message
CancelResultMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.CancelResultMessage
clear() - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
clear() - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
clear() - Method in class com.birbit.android.jobqueue.JobManager: Clears all waiting Jobs in the JobManager.
clear() - Method in interface com.birbit.android.jobqueue.JobQueue: clear all jobs in the queue.
CLEAR - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
clear() - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
clear() - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
clear() - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
clear() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: clear all jobs in the queue.
clear() - Method in class com.birbit.android.jobqueue.RunningJobSet
clearLogger() - Static method in class com.birbit.android.jobqueue.log.JqLog
clearTags() - Method in class com.birbit.android.jobqueue.Params
columnIndex - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
com.birbit.android.jobqueue - package com.birbit.android.jobqueue
com.birbit.android.jobqueue.cachedQueue - package com.birbit.android.jobqueue.cachedQueue
com.birbit.android.jobqueue.callback - package com.birbit.android.jobqueue.callback
com.birbit.android.jobqueue.config - package com.birbit.android.jobqueue.config
com.birbit.android.jobqueue.di - package com.birbit.android.jobqueue.di
com.birbit.android.jobqueue.inMemoryQueue - package com.birbit.android.jobqueue.inMemoryQueue
com.birbit.android.jobqueue.log - package com.birbit.android.jobqueue.log
com.birbit.android.jobqueue.messaging - package com.birbit.android.jobqueue.messaging
com.birbit.android.jobqueue.messaging.message - package com.birbit.android.jobqueue.messaging.message
com.birbit.android.jobqueue.network - package com.birbit.android.jobqueue.network
com.birbit.android.jobqueue.persistentQueue.sqlite - package com.birbit.android.jobqueue.persistentQueue.sqlite
com.birbit.android.jobqueue.scheduling - package com.birbit.android.jobqueue.scheduling
com.birbit.android.jobqueue.timer - package com.birbit.android.jobqueue.timer
CommandMessage - Class in com.birbit.android.jobqueue.messaging.message
CommandMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.CommandMessage
Configuration - Class in com.birbit.android.jobqueue.config: JobManager configuration object
Configuration.Builder - Class in com.birbit.android.jobqueue.config
Constraint - Class in com.birbit.android.jobqueue: This class is used when querying JobQueues to fetch particular jobs.
Constraint() - Constructor for class com.birbit.android.jobqueue.Constraint
ConstraintChangeMessage - Class in com.birbit.android.jobqueue.messaging.message
ConstraintChangeMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.ConstraintChangeMessage
consume(MessageQueueConsumer) - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
consume(MessageQueueConsumer) - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
consume(MessageQueueConsumer) - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
consumerKeepAlive(int) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: When JobManager runs out of `ready` jobs, it will keep consumers alive for this duration.
consumerThreadPriority(int) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: Sets the priority for the threads of this manager.
count() - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
count() - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
count() - Method in class com.birbit.android.jobqueue.JobManager: Returns the number of jobs in the JobManager.
count() - Method in interface com.birbit.android.jobqueue.JobQueue: Returns the # of jobs that are waiting to be run
COUNT - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
count() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: Returns the # of jobs that are waiting to be run
COUNT_READY - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
countReady(SQLiteDatabase, StringBuilder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
countReadyJobs(Constraint) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
countReadyJobs(Constraint) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
countReadyJobs() - Method in class com.birbit.android.jobqueue.JobManager: Returns the number of jobs that are ready to be executed but waiting in the queue.
countReadyJobs(Constraint) - Method in interface com.birbit.android.jobqueue.JobQueue: counts the # of jobs that can run now.
countReadyJobs(Constraint) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
create(String, SqlHelper.Property, SqlHelper.Property...) - Static method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
createdNs(long) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
createExponentialBackoff(int, long) - Static method in class com.birbit.android.jobqueue.RetryConstraint: Creates a response that will exponentially back off the job.
createNonPersistent(Configuration, long) - Method in class com.birbit.android.jobqueue.DefaultQueueFactory
createNonPersistent(Configuration, long) - Method in interface com.birbit.android.jobqueue.QueueFactory
createPersistentQueue(Configuration, long) - Method in class com.birbit.android.jobqueue.DefaultQueueFactory
createPersistentQueue(Configuration, long) - Method in interface com.birbit.android.jobqueue.QueueFactory
createSchedulerFor(Context, Class<? extends FrameworkJobSchedulerService>) - Static method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService: Creates a scheduler for the given service.
createSchedulerFor(Context, Class<? extends GcmJobSchedulerService>) - Static method in class com.birbit.android.jobqueue.scheduling.GcmJobSchedulerService: Creates a scheduler for the given service.
createSelect(String, Integer, SqlHelper.Order...) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
createSelectOneField(String, String, Integer, SqlHelper.Order...) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
customLogger(CustomLogger) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: you can provide a custom logger to get logs from JobManager.
CustomLogger - Interface in com.birbit.android.jobqueue.log: You can provide your own logger implementation to JobManager it is very similar to Roboguice's logger

D

d(String, Object...) - Method in interface com.birbit.android.jobqueue.log.CustomLogger
d(String, Object...) - Static method in class com.birbit.android.jobqueue.log.JqLog
d(String, Object...) - Method in class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
DbOpenHelper - Class in com.birbit.android.jobqueue.persistentQueue.sqlite: Helper class for SqliteJobQueue to handle database connection
DbOpenHelper(Context, String) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.DbOpenHelper
deadline(long, boolean) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
DEFAULT_BATCHING_PERIOD_IN_MS - Static variable in class com.birbit.android.jobqueue.BatchingScheduler
DEFAULT_ID - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default id for a Job.
DEFAULT_LOAD_FACTOR_PER_CONSUMER - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default number of jobs per thread before JobManager creates a new one
DEFAULT_RETRY_LIMIT - Static variable in class com.birbit.android.jobqueue.Job
DEFAULT_THREAD_KEEP_ALIVE_SECONDS - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default timeout for an idle thread before it is destroyed
DEFAULT_THREAD_PRIORITY - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default priority for new job consumers (Thread.NORM_PRIORITY).
DefaultQueueFactory - Class in com.birbit.android.jobqueue: Default implementation of QueueFactory that creates one SqliteJobQueue and one SimpleInMemoryPriorityQueue both are wrapped inside a CachedJobQueue to improve performance
DefaultQueueFactory() - Constructor for class com.birbit.android.jobqueue.DefaultQueueFactory
DefaultQueueFactory(SqliteJobQueue.JobSerializer) - Constructor for class com.birbit.android.jobqueue.DefaultQueueFactory
delayInMs(long) - Method in class com.birbit.android.jobqueue.Params: Delays the job in given ms.
delayUntilNs(long) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
DependencyInjector - Interface in com.birbit.android.jobqueue.di: interface that can be provided to JobManager for dependency injection it is called before the job's onAdded method is called.
deserialize(byte[]) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue.JavaSerializer
deserialize(byte[]) - Method in interface com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue.JobSerializer
destroy() - Method in class com.birbit.android.jobqueue.CallbackManager
destroy() - Method in class com.birbit.android.jobqueue.JobManager: Destroys the JobManager.
destroy() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
DISCONNECTED - Static variable in interface com.birbit.android.jobqueue.network.NetworkUtil
drop(String) - Static method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper

E

e(Throwable, String, Object...) - Method in interface com.birbit.android.jobqueue.log.CustomLogger
e(String, Object...) - Method in interface com.birbit.android.jobqueue.log.CustomLogger
e(Throwable, String, Object...) - Static method in class com.birbit.android.jobqueue.log.JqLog
e(String, Object...) - Static method in class com.birbit.android.jobqueue.log.JqLog
e(Throwable, String, Object...) - Method in class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
e(String, Object...) - Method in class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
equals(Object) - Method in class com.birbit.android.jobqueue.JobHolder
ErrorLogger() - Constructor for class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
excludeRunning() - Method in class com.birbit.android.jobqueue.Constraint: Returns true if running jobs should be excluded from the query

F

findJobById(String) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
findJobById(String) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
findJobById(String) - Method in interface com.birbit.android.jobqueue.JobQueue: returns the job with the given id if it exists in the queue
findJobById(String) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: returns the job with the given id if it exists in the queue
findJobs(Constraint) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
findJobs(Constraint) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
findJobs(Constraint) - Method in interface com.birbit.android.jobqueue.JobQueue: Returns jobs that matches the given constraints
findJobs(Constraint) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
findJobs(SqlHelper) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
ForeignKey(String, String) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.ForeignKey
foreignKey - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
FOREVER - Static variable in class com.birbit.android.jobqueue.Params: Used in delay / override deadline.
FrameworkJobSchedulerService - Class in com.birbit.android.jobqueue.scheduling: The service implementation for the framework job scheduler
FrameworkJobSchedulerService() - Constructor for class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService

G

GcmJobSchedulerService - Class in com.birbit.android.jobqueue.scheduling
GcmJobSchedulerService() - Constructor for class com.birbit.android.jobqueue.scheduling.GcmJobSchedulerService
getActiveConsumerCount() - Method in class com.birbit.android.jobqueue.JobManager: Returns the number of consumer threads that are currently running Jobs.
getAppContext() - Method in class com.birbit.android.jobqueue.config.Configuration
getApplicationContext() - Method in class com.birbit.android.jobqueue.Job: Convenience method to get the application context in a Job.
getCallback() - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
getCallback() - Method in class com.birbit.android.jobqueue.messaging.message.CancelResultMessage
getCallback() - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
getCancelledJobs() - Method in class com.birbit.android.jobqueue.CancelResult
getCancelOnDeadline() - Method in class com.birbit.android.jobqueue.Params: Returns what JobManager will do if job reaches its deadline.
getConstraint() - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
getConstraint() - Method in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
getConsumerKeepAlive() - Method in class com.birbit.android.jobqueue.config.Configuration
getCountStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getCreatedNs() - Method in class com.birbit.android.jobqueue.JobHolder
getCurrentRunCount() - Method in class com.birbit.android.jobqueue.Job: Before each run, JobManager sets this number.
getCustomLogger() - Method in class com.birbit.android.jobqueue.config.Configuration
getData() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
getDb() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
getDeadlineMs() - Method in class com.birbit.android.jobqueue.Params
getDeadlineNs() - Method in class com.birbit.android.jobqueue.JobHolder
getDelayInMs() - Method in class com.birbit.android.jobqueue.Job: used by JobManager to assign proper delay at the time job is added.
getDelayInMs() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint: The delay for the job
getDelayMs() - Method in class com.birbit.android.jobqueue.Params
getDelayUntilNs() - Method in class com.birbit.android.jobqueue.JobHolder
getDeleteJobTagsStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getDeleteStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getDependencyInjector() - Method in class com.birbit.android.jobqueue.config.Configuration
getExcludeGroups() - Method in class com.birbit.android.jobqueue.Constraint: The list of groups to be excluded.
getExcludeJobIds() - Method in class com.birbit.android.jobqueue.Constraint: The list of jobs ids that should be excluded from the result
getFailedToCancel() - Method in class com.birbit.android.jobqueue.CancelResult
getGroupId() - Method in class com.birbit.android.jobqueue.JobHolder
getGroupId() - Method in class com.birbit.android.jobqueue.Params
getId() - Method in class com.birbit.android.jobqueue.config.Configuration
getId() - Method in class com.birbit.android.jobqueue.Job
getId() - Method in class com.birbit.android.jobqueue.JobHolder
getInsertionOrder() - Method in class com.birbit.android.jobqueue.JobHolder
getInsertOrReplaceStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getInsertStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getInsertTagsStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getJob() - Method in class com.birbit.android.jobqueue.JobHolder
getJob() - Method in class com.birbit.android.jobqueue.messaging.message.AddJobMessage
getJob() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
getJobHolder() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobMessage
getJobHolder() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
getJobManager() - Method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService: Return the JobManager that is associated with this service
getJobManager() - Method in class com.birbit.android.jobqueue.scheduling.GcmJobSchedulerService: Return the JobManager that is associated with this service
getJobManagerExecutionThread() - Method in class com.birbit.android.jobqueue.JobManager: Returns the main thread of the JobManager.
getJobStatus(String) - Method in class com.birbit.android.jobqueue.JobManager: Returns the current status of a given job
getLastJobCompleted() - Method in class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
getLoadFactor() - Method in class com.birbit.android.jobqueue.config.Configuration
getMaxConsumerCount() - Method in class com.birbit.android.jobqueue.config.Configuration
getMaxNetworkType() - Method in class com.birbit.android.jobqueue.Constraint: Returns the max allowed network type
getMinConsumerCount() - Method in class com.birbit.android.jobqueue.config.Configuration
getNetworkStatus(Context) - Method in interface com.birbit.android.jobqueue.network.NetworkUtil: Returns the current connection status.
getNetworkStatus(Context) - Method in class com.birbit.android.jobqueue.network.NetworkUtilImpl
getNetworkStatus() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
getNetworkUtil() - Method in class com.birbit.android.jobqueue.config.Configuration
getNewDelayInMs() - Method in class com.birbit.android.jobqueue.RetryConstraint
getNewPriority() - Method in class com.birbit.android.jobqueue.RetryConstraint
getNextDelayForGroups() - Method in class com.birbit.android.jobqueue.RunningJobSet
getNextJobDelayUntilNs(Constraint) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
getNextJobDelayUntilNs(Constraint) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
getNextJobDelayUntilNs(Constraint) - Method in interface com.birbit.android.jobqueue.JobQueue: Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.
getNextJobDelayUntilNs(Constraint) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.
getNowInNs() - Method in class com.birbit.android.jobqueue.Constraint
getOnJobFetchedForRunningStatement() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
getOverrideDeadlineInMs() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint: The deadline in ms after which the job should be run even if the constraints are not match.
getPriority() - Method in class com.birbit.android.jobqueue.Job: used by JobManager to assign proper priority at the time job is added.
getPriority() - Method in class com.birbit.android.jobqueue.JobHolder
getPriority() - Method in class com.birbit.android.jobqueue.Params
getQueueFactory() - Method in class com.birbit.android.jobqueue.config.Configuration
getRequiredNetworkType() - Method in class com.birbit.android.jobqueue.JobHolder: Returns the type of network required by this job.
getResult() - Method in class com.birbit.android.jobqueue.messaging.message.CancelResultMessage
getResult() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
getResultCode() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
getRetryConstraint() - Method in class com.birbit.android.jobqueue.JobHolder
getRetryLimit() - Method in class com.birbit.android.jobqueue.Job: By default, jobs will be retried DEFAULT_RETRY_LIMIT times.
getRunCount() - Method in class com.birbit.android.jobqueue.JobHolder
getRunGroupId() - Method in class com.birbit.android.jobqueue.Job: Some jobs may require being run synchronously.
getRunnable() - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
getRunningSessionId() - Method in class com.birbit.android.jobqueue.JobHolder
getSafe() - Method in class com.birbit.android.jobqueue.RunningJobSet
getScheduler() - Method in class com.birbit.android.jobqueue.config.Configuration
getScheduler() - Method in class com.birbit.android.jobqueue.JobManager: The scheduler that was given to this JobManager when it was initialized.
getScheduler() - Method in class com.birbit.android.jobqueue.scheduling.GcmJobSchedulerService
getSingleId() - Method in class com.birbit.android.jobqueue.Params
getSingleInstanceId() - Method in class com.birbit.android.jobqueue.Job: Some jobs only need a single instance to be queued to run.
getSingleInstanceId() - Method in class com.birbit.android.jobqueue.JobHolder
getStringArg() - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
getTagConstraint() - Method in class com.birbit.android.jobqueue.Constraint: The tag constraint to be used while querying with tags.
getTags() - Method in class com.birbit.android.jobqueue.Constraint: The set of tags.
getTags() - Method in class com.birbit.android.jobqueue.Job: Returns a readonly set of tags attached to this Job.
getTags() - Method in class com.birbit.android.jobqueue.JobHolder
getTags() - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
getTags() - Method in class com.birbit.android.jobqueue.Params
getThreadFactory() - Method in class com.birbit.android.jobqueue.config.Configuration
getThreadPriority() - Method in class com.birbit.android.jobqueue.config.Configuration
getThrowable() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
getTimeLimit() - Method in class com.birbit.android.jobqueue.Constraint: Exclude jobs whose run time is after this time.
getTimer() - Method in class com.birbit.android.jobqueue.config.Configuration
getUuid() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint: The unique id assigned by the job manager.
getWhat() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
getWhat() - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
getWhat() - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
getWhat() - Method in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
getWorker() - Method in class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
getWorker() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
groupBy(String) - Method in class com.birbit.android.jobqueue.Params: Sets the group id.
groupId(String) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
groupId - Variable in class com.birbit.android.jobqueue.JobHolder

H

handleMessage(Message) - Method in class com.birbit.android.jobqueue.messaging.MessageQueueConsumer
hasDeadline() - Method in class com.birbit.android.jobqueue.JobHolder
hasDelay() - Method in class com.birbit.android.jobqueue.JobHolder
hashCode() - Method in class com.birbit.android.jobqueue.JobHolder
hasTags() - Method in class com.birbit.android.jobqueue.JobHolder

I

id(String) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: provide and ID for this job manager to be used while creating persistent queue.
id(String) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
id - Variable in class com.birbit.android.jobqueue.JobHolder
init(Context, Scheduler.Callback) - Method in class com.birbit.android.jobqueue.BatchingScheduler
init(Context, Scheduler.Callback) - Method in class com.birbit.android.jobqueue.scheduling.Scheduler
inject(Job) - Method in interface com.birbit.android.jobqueue.di.DependencyInjector
injector(DependencyInjector) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: JobManager is suitable for DependencyInjection.
insert(JobHolder) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
insert(JobHolder) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
insert(JobHolder) - Method in interface com.birbit.android.jobqueue.JobQueue: Inserts the given JobHolder.
insert(JobHolder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: Inserts the given JobHolder.
insertionOrder(long) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
insertOrReplace(JobHolder) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
insertOrReplace(JobHolder) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
insertOrReplace(JobHolder) - Method in interface com.birbit.android.jobqueue.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)
insertOrReplace(JobHolder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: 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)
IntCallback - Interface in com.birbit.android.jobqueue: Internal interface to mimic sync requests.
IntCallback.MessageWithCallback - Interface in com.birbit.android.jobqueue
INTERNAL_RUNNABLE - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
inTestMode() - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: Sets the JobManager in test mode.
isByUserRequest() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
isCancelled() - Method in class com.birbit.android.jobqueue.Job: Returns true if job is cancelled.
isCancelled() - Method in class com.birbit.android.jobqueue.JobHolder
isCancelledSingleId() - Method in class com.birbit.android.jobqueue.JobHolder
isDeadlineReached() - Method in class com.birbit.android.jobqueue.Job: Returns true if the job's deadline is reached.
isDebugEnabled() - Method in interface com.birbit.android.jobqueue.log.CustomLogger: JobManager may call this before logging something that is (relatively) expensive to calculate
isDebugEnabled() - Method in class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
isDebugEnabled() - Static method in class com.birbit.android.jobqueue.log.JqLog
isInTestMode() - Method in class com.birbit.android.jobqueue.config.Configuration
isNetworkRequired() - Method in class com.birbit.android.jobqueue.Params
isPersistent() - Method in class com.birbit.android.jobqueue.Job: Whether we should add this job to disk or non-persistent queue
isPersistent() - Method in class com.birbit.android.jobqueue.Params
isRunning() - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
isUnmeteredNetworkRequired() - Method in class com.birbit.android.jobqueue.Params

J

JavaSerializer() - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue.JavaSerializer
Job - Class in com.birbit.android.jobqueue: Base class for all of your jobs.
Job(Params) - Constructor for class com.birbit.android.jobqueue.Job
job(Job) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
JOB_STATUS - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
JobConsumerIdleMessage - Class in com.birbit.android.jobqueue.messaging.message
JobConsumerIdleMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
JobHolder - Class in com.birbit.android.jobqueue: Container class to address Jobs inside job manager.
JobHolder.Builder - Class in com.birbit.android.jobqueue
JobManager - Class in com.birbit.android.jobqueue
JobManager(Configuration) - Constructor for class com.birbit.android.jobqueue.JobManager: Creates a JobManager with the given configuration
JobManagerCallback - Interface in com.birbit.android.jobqueue.callback: A callback class that you can attach to the JobManager to get notified as Jobs change states.
JobManagerCallbackAdapter - Class in com.birbit.android.jobqueue.callback: An empty implementation of JobManagerCallback.
JobManagerCallbackAdapter() - Constructor for class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
JobQueue - Interface in com.birbit.android.jobqueue: Interface that any JobQueue should implement These job queues can be given to JobManager.
jobSerializer(SqliteJobQueue.JobSerializer) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: convenient configuration to replace job serializer while using SqliteJobQueue queue for persistence.
JobStatus - Enum in com.birbit.android.jobqueue: Identifies the current status of a job if it is in the queue
JqLog - Class in com.birbit.android.jobqueue.log: Wrapper around CustomLogger.
JqLog() - Constructor for class com.birbit.android.jobqueue.log.JqLog
JqLog.ErrorLogger - Class in com.birbit.android.jobqueue.log

L

loadFactor(int) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: calculated by # of jobs (running+waiting) per thread for instance, at a given time, if you have two consumers and 10 jobs in waiting queue (or running right now), load is (10/2) =5 defaults to Configuration.DEFAULT_LOAD_FACTOR_PER_CONSUMER
logJobs() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue

M

markAsCancelled() - Method in class com.birbit.android.jobqueue.JobHolder
markAsCancelledSingleId() - Method in class com.birbit.android.jobqueue.JobHolder
matches(String[], Set<String>) - Method in enum com.birbit.android.jobqueue.TagConstraint
matches(Collection<String>, Set<String>) - Method in enum com.birbit.android.jobqueue.TagConstraint
MAX_CONSUMER_COUNT - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default max number of consumers that will be created by the JobManager
maxConsumerCount(int) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: # of max consumers to run concurrently.
Message - Class in com.birbit.android.jobqueue.messaging
Message(Type) - Constructor for class com.birbit.android.jobqueue.messaging.Message
MessageFactory - Class in com.birbit.android.jobqueue.messaging
MessageFactory() - Constructor for class com.birbit.android.jobqueue.messaging.MessageFactory
MessagePredicate - Interface in com.birbit.android.jobqueue.messaging
MessageQueue - Interface in com.birbit.android.jobqueue.messaging
MessageQueueConsumer - Class in com.birbit.android.jobqueue.messaging
MessageQueueConsumer() - Constructor for class com.birbit.android.jobqueue.messaging.MessageQueueConsumer
METERED - Static variable in interface com.birbit.android.jobqueue.network.NetworkUtil
MIN_CONSUMER_COUNT - Static variable in class com.birbit.android.jobqueue.config.Configuration: The default min number of consumers that will be kept alive by the JobManager
MIN_DELAY_TO_USE_SCHEDULER_IN_MS - Static variable in class com.birbit.android.jobqueue.JobManager: The min delay in MS which will trigger usage of JobScheduler.
minConsumerCount(int) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: you can specify to keep minConsumers alive even if there are no ready jobs.

N

nanoTime() - Method in class com.birbit.android.jobqueue.timer.SystemTimer
nanoTime() - Method in interface com.birbit.android.jobqueue.timer.Timer
NETWORK_CHECK_INTERVAL - Static variable in class com.birbit.android.jobqueue.JobManager
NetworkEventProvider - Interface in com.birbit.android.jobqueue.network: An interface that NetworkUtil can implement if it supports a callback method when network state is changed This is not mandatory but highly suggested so that JobManager can avoid busy loops when there is a job waiting for network and there is no network available
NetworkEventProvider.Listener - Interface in com.birbit.android.jobqueue.network
networkUtil(NetworkUtil) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: By default, Job Manager comes with a simple NetworkUtilImpl that queries ConnectivityManager to check if network connection exists.
NetworkUtil - Interface in com.birbit.android.jobqueue.network: Interface which you can implement if you want to provide a custom Network callback.
NetworkUtil.NetworkStatus - Annotation Type in com.birbit.android.jobqueue.network: Order of these constant values matter as they are relied upon to be incrementing in terms of availability.
NetworkUtilImpl - Class in com.birbit.android.jobqueue.network: default implementation for network Utility to observe network events
NetworkUtilImpl(Context) - Constructor for class com.birbit.android.jobqueue.network.NetworkUtilImpl
NEVER - Static variable in class com.birbit.android.jobqueue.Params: Used in delay / override deadline.
next(MessageQueueConsumer) - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
nextJob(SqlHelper) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
nextJobAndIncRunCount(Constraint) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
nextJobAndIncRunCount(Constraint) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
nextJobAndIncRunCount(Constraint) - Method in interface com.birbit.android.jobqueue.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.
nextJobAndIncRunCount(Constraint) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: Returns the next available job in the data set It should also assign the sessionId as the RunningSessionId and persist that data if necessary.
nextJobDelayUntil(SQLiteDatabase, SqlHelper) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
NOT_DELAYED_JOB_DELAY - Static variable in class com.birbit.android.jobqueue.JobManager
NOT_RUNNING_SESSION_ID - Static variable in class com.birbit.android.jobqueue.JobManager
notifyAfterRun(Job, int) - Method in class com.birbit.android.jobqueue.CallbackManager
notifyCancelResult(CancelResult, CancelResult.AsyncCancelCallback) - Method in class com.birbit.android.jobqueue.CallbackManager
notifyObject(Object) - Method in class com.birbit.android.jobqueue.timer.SystemTimer
notifyObject(Object) - Method in interface com.birbit.android.jobqueue.timer.Timer
notifyOnAdded(Job) - Method in class com.birbit.android.jobqueue.CallbackManager
notifyOnCancel(Job, boolean, Throwable) - Method in class com.birbit.android.jobqueue.CallbackManager
notifyOnDone(Job) - Method in class com.birbit.android.jobqueue.CallbackManager
notifyOnRun(Job, int) - Method in class com.birbit.android.jobqueue.CallbackManager
NS_PER_MS - Static variable in class com.birbit.android.jobqueue.JobManager

O

obtain(Class<T>) - Method in class com.birbit.android.jobqueue.messaging.MessageFactory
ON_ADDED - Static variable in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
ON_AFTER_RUN - Static variable in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
ON_CANCEL - Static variable in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
ON_DONE - Static variable in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
ON_RUN - Static variable in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
onAdded() - Method in interface com.birbit.android.jobqueue.AsyncAddCallback
onAdded() - Method in class com.birbit.android.jobqueue.Job: Called when the job is added to disk and committed.
onAfterJobRun(Job, int) - Method in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Called after a Job is run and its run result has been handled.
onAfterJobRun(Job, int) - Method in class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
onCancel(int, Throwable) - Method in class com.birbit.android.jobqueue.Job: Called when a job is cancelled.
onCancel(int) - Method in class com.birbit.android.jobqueue.JobHolder
onCancelled(CancelResult) - Method in interface com.birbit.android.jobqueue.CancelResult.AsyncCancelCallback: When job cancellation is complete, this method is called by the JobManager.
onCreate(SQLiteDatabase) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.DbOpenHelper
onCreate() - Method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService
onDestroy() - Method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService
onDone(Job) - Method in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Called after a Job is removed from the JobManager.
onDone(Job) - Method in class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
onDowngrade(SQLiteDatabase, int, int) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.DbOpenHelper
onFinished(SchedulerConstraint, boolean) - Method in class com.birbit.android.jobqueue.BatchingScheduler
onFinished(SchedulerConstraint, boolean) - Method in class com.birbit.android.jobqueue.scheduling.Scheduler: Called by the JobManager when a scheduled constraint is handled.
onIdle() - Method in class com.birbit.android.jobqueue.messaging.MessageQueueConsumer
onJobAdded(Job) - Method in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Called when a Job is added to the JobManager.
onJobAdded(Job) - Method in class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
onJobCancelled(JobHolder) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
onJobCancelled(Job, boolean, Throwable) - Method in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Called when a job is cancelled.
onJobCancelled(Job, boolean, Throwable) - Method in class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
onJobCancelled(JobHolder) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
onJobCancelled(JobHolder) - Method in interface com.birbit.android.jobqueue.JobQueue: Called when a job is cancelled by the user.
onJobCancelled(JobHolder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
onJobRun(Job, int) - Method in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Called after a Job has been Run.
onJobRun(Job, int) - Method in class com.birbit.android.jobqueue.callback.JobManagerCallbackAdapter
onMessage(Message) - Method in interface com.birbit.android.jobqueue.messaging.MessagePredicate
onNetworkChange(int) - Method in interface com.birbit.android.jobqueue.network.NetworkEventProvider.Listener
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.AddJobMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.CancelResultMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.ConstraintChangeMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.Message
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
onRecycled() - Method in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
onResult(int) - Method in interface com.birbit.android.jobqueue.IntCallback
onRun() - Method in class com.birbit.android.jobqueue.Job: The actual method that should to the work.
onRunTask(TaskParams) - Method in class com.birbit.android.jobqueue.scheduling.GcmJobSchedulerService
onStart() - Method in class com.birbit.android.jobqueue.messaging.MessageQueueConsumer
onStartJob(JobParameters) - Method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService
onStopJob(JobParameters) - Method in class com.birbit.android.jobqueue.scheduling.FrameworkJobSchedulerService
onUpgrade(SQLiteDatabase, int, int) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.DbOpenHelper
Order(SqlHelper.Property, SqlHelper.Order.Type) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Order
overrideDeadlineToCancelInMs(long) - Method in class com.birbit.android.jobqueue.Params: Set a deadline on the job's constraints.
overrideDeadlineToRunInMs(long) - Method in class com.birbit.android.jobqueue.Params: Set a deadline on the job's constraints.

P

Params - Class in com.birbit.android.jobqueue: Job builder object to have a more readable design.
Params(int) - Constructor for class com.birbit.android.jobqueue.Params
persist() - Method in class com.birbit.android.jobqueue.Params: Marks the job as persistent.
persistent(boolean) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
persistent - Variable in class com.birbit.android.jobqueue.JobHolder
POKE - Static variable in class com.birbit.android.jobqueue.messaging.message.CommandMessage
post(Message) - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
post(Message) - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
post(Message) - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
postAt(Message, long) - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
postAt(Message, long) - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
postAt(Message, long) - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
postAtFront(Message) - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
priority(int) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
PriorityMessageQueue - Class in com.birbit.android.jobqueue.messaging: Uses multiple message queues to simulate priority.
PriorityMessageQueue(Timer, MessageFactory) - Constructor for class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
Property(String, String, int) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
Property(String, String, int, SqlHelper.ForeignKey) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
Property(String, String, int, SqlHelper.ForeignKey, boolean) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
PublicQueryMessage - Class in com.birbit.android.jobqueue.messaging.message
PublicQueryMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage

Q

query - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
queueFactory(QueueFactory) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: JobManager needs one persistent and one non-persistent JobQueue to function.
QueueFactory - Interface in com.birbit.android.jobqueue
QUIT - Static variable in class com.birbit.android.jobqueue.messaging.message.CommandMessage

R

REACHED_DEADLINE - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used when a Job is cancelled for hitting its deadline.
REACHED_RETRY_LIMIT - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used when job throws an exception in Job.onRun() and will be cancelled because it has reached its retry limit.
readyNs - Variable in class com.birbit.android.jobqueue.messaging.Message
release(Message) - Method in class com.birbit.android.jobqueue.messaging.MessageFactory
remove(JobHolder) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
remove(JobHolder) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
remove(JobHolder) - Method in interface com.birbit.android.jobqueue.JobQueue: Removes the job from the data store.
remove(JobHolder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue: Removes the job from the data store.
remove(String) - Method in class com.birbit.android.jobqueue.RunningJobSet
removeCallback(JobManagerCallback) - Method in class com.birbit.android.jobqueue.JobManager: Removes the JobManagerCallback from the callbacks list.
removeTags(String...) - Method in class com.birbit.android.jobqueue.Params: Removes the given tags from the Job.
request(SchedulerConstraint) - Method in class com.birbit.android.jobqueue.BatchingScheduler
request(SchedulerConstraint) - Method in class com.birbit.android.jobqueue.scheduling.Scheduler
requiredNetworkType(int) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
requireNetwork() - Method in class com.birbit.android.jobqueue.Params: Sets the Job as requiring network.
requiresNetwork() - Method in class com.birbit.android.jobqueue.Job: Returns whether job requires a network connection to be run or not.
requiresUnmeteredNetwork() - Method in class com.birbit.android.jobqueue.Job: Returns whether job requires a unmetered network connection to be run or not.
requireUnmeteredNetwork() - Method in class com.birbit.android.jobqueue.Params: Sets the Job as requiring UNMETERED network.
resetDelaysOnRestart() - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: JobManager 1.x versions used to clear delay for existing jobs when the application is restarted because there is no reliable way to measure time difference between device reboots (and from the app's perspective, device reboot is no different than app restart).
resetDelaysOnRestart() - Method in class com.birbit.android.jobqueue.config.Configuration
resetDelayTimesTo(long) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
RESULT_CANCEL_CANCELLED_VIA_SHOULD_RE_RUN - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.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).
RESULT_CANCEL_CANCELLED_WHILE_RUNNING - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.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.
RESULT_CANCEL_REACHED_RETRY_LIMIT - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.onJobRun(Job, int) when job throws an exception in Job.onRun() and will be cancelled because it has reached its retry limit.
RESULT_CANCEL_SINGLE_INSTANCE_WHILE_RUNNING - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.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.
RESULT_FAIL_WILL_RETRY - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.onJobRun(Job, int) when job throws an exception in Job.onRun() and wanted to retry via Job.shouldReRunOnThrowable(Throwable, int, int).
RESULT_SUCCEED - Static variable in interface com.birbit.android.jobqueue.callback.JobManagerCallback: Used in JobManagerCallback.onJobRun(Job, int) when properly completes Job.onRun().
RETRY - Static variable in class com.birbit.android.jobqueue.RetryConstraint
RetryConstraint - Class in com.birbit.android.jobqueue: Created by Job.shouldReRunOnThrowable(Throwable, int, int).
RetryConstraint(boolean) - Constructor for class com.birbit.android.jobqueue.RetryConstraint
RUN_RESULT_FAIL_FOR_CANCEL - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
RUN_RESULT_FAIL_RUN_LIMIT - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
RUN_RESULT_FAIL_SHOULD_RE_RUN - Static variable in class com.birbit.android.jobqueue.JobHolder: The job decided not to run in shouldReRun method.
RUN_RESULT_FAIL_SINGLE_ID - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
RUN_RESULT_HIT_DEADLINE - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
RUN_RESULT_SUCCESS - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
RUN_RESULT_TRY_AGAIN - Static variable in class com.birbit.android.jobqueue.JobHolder: Internal constant.
runCount(int) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
RunJobMessage - Class in com.birbit.android.jobqueue.messaging.message
RunJobMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.RunJobMessage
RunJobResultMessage - Class in com.birbit.android.jobqueue.messaging.message
RunJobResultMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
RUNNABLE - Static variable in class com.birbit.android.jobqueue.messaging.message.CommandMessage
RunningJobSet - Class in com.birbit.android.jobqueue: a util class that holds running jobs sorted by name and unique.
RunningJobSet(Timer) - Constructor for class com.birbit.android.jobqueue.RunningJobSet
runningSessionId(long) - Method in class com.birbit.android.jobqueue.JobHolder.Builder

S

SafeMessageQueue - Class in com.birbit.android.jobqueue.messaging
SafeMessageQueue(Timer, MessageFactory, String) - Constructor for class com.birbit.android.jobqueue.messaging.SafeMessageQueue
scheduler(Scheduler, boolean) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: Assigns a scheduler that can be used to wake up the application when JobManager has jobs to execute.
scheduler(Scheduler) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: Assigns a scheduler that can be used to wake up the application when JobManager has jobs to execute.
Scheduler - Class in com.birbit.android.jobqueue.scheduling: This class handles communication and tracking with a scheduler that can wake up the app / job manager based on external events.
Scheduler() - Constructor for class com.birbit.android.jobqueue.scheduling.Scheduler
Scheduler.Callback - Interface in com.birbit.android.jobqueue.scheduling: Internal class that handles the communication between the JobManager and the scheduler
SCHEDULER_START - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
SchedulerConstraint - Class in com.birbit.android.jobqueue.scheduling: The constraints that are passed into Scheduler from JobManager
SchedulerConstraint(String) - Constructor for class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
SchedulerMessage - Class in com.birbit.android.jobqueue.messaging.message: The messages with the scheduler
SchedulerMessage() - Constructor for class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
serialize(Object) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue.JavaSerializer
serialize(Object) - Method in interface com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue.JobSerializer
set(Job, int) - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
set(Job, int, int) - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
set(Job, int, boolean, Throwable) - Method in class com.birbit.android.jobqueue.messaging.message.CallbackMessage
set(CancelResult.AsyncCancelCallback, CancelResult) - Method in class com.birbit.android.jobqueue.messaging.message.CancelResultMessage
set(int) - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
set(int, IntCallback) - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
set(int, String, IntCallback) - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
set(int, SchedulerConstraint) - Method in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
setApplicationContext(Context) - Method in class com.birbit.android.jobqueue.JobHolder
setApplyNewDelayToGroup(boolean) - Method in class com.birbit.android.jobqueue.RetryConstraint: Sets whether the delay in the constraint should be applied to the whole group.
setCallback(IntCallback) - Method in interface com.birbit.android.jobqueue.IntCallback.MessageWithCallback
setCallback(CancelResult.AsyncCancelCallback) - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
setCallback(IntCallback) - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
setConstraint(TagConstraint) - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
setCustomLogger(CustomLogger) - Static method in class com.birbit.android.jobqueue.log.JqLog
setData(Object) - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
setDeadlineIsReached(boolean) - Method in class com.birbit.android.jobqueue.JobHolder
setDelayInMs(long) - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
setDelayMs(long) - Method in class com.birbit.android.jobqueue.Params: convenience method to set delay
setDelayUntilNs(long) - Method in class com.birbit.android.jobqueue.JobHolder
setGroupId(String) - Method in class com.birbit.android.jobqueue.Params: convenience method to set group id.
setInsertionOrder(long) - Method in class com.birbit.android.jobqueue.JobHolder
setJob(Job) - Method in class com.birbit.android.jobqueue.messaging.message.AddJobMessage
setJobHolder(JobHolder) - Method in class com.birbit.android.jobqueue.messaging.message.RunJobMessage
setJobHolder(JobHolder) - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
setLastJobCompleted(long) - Method in class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
setListener(NetworkEventProvider.Listener) - Method in interface com.birbit.android.jobqueue.network.NetworkEventProvider
setListener(NetworkEventProvider.Listener) - Method in class com.birbit.android.jobqueue.network.NetworkUtilImpl
setNetworkStatus(int) - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
setNewDelayInMs(Long) - Method in class com.birbit.android.jobqueue.RetryConstraint: Sets a timeout until the Job is tried again.
setNewPriority(Integer) - Method in class com.birbit.android.jobqueue.RetryConstraint: Updates the Job's priority.
setNowInNs(long) - Method in class com.birbit.android.jobqueue.Constraint
setOverrideDeadlineInMs(Long) - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
setPersistent(boolean) - Method in class com.birbit.android.jobqueue.Params: convenience method to set whether JobManager should persist this job or not.
setPriority(int) - Method in class com.birbit.android.jobqueue.JobHolder
setRequiresNetwork(boolean) - Method in class com.birbit.android.jobqueue.Params: Convenience method to set network requirement.
setRequiresUnmeteredNetwork(boolean) - Method in class com.birbit.android.jobqueue.Params: Convenience method to set unmetered network requirement.
setResult(int) - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
setRetry(boolean) - Method in class com.birbit.android.jobqueue.RetryConstraint: Set whether the Job should be run again or cancelled.
setRunCount(int) - Method in class com.birbit.android.jobqueue.JobHolder
setRunnable(Runnable) - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
setRunningSessionId(long) - Method in class com.birbit.android.jobqueue.JobHolder
setSingleId(String) - Method in class com.birbit.android.jobqueue.Params: convenience method to set single id.
setTags(String[]) - Method in class com.birbit.android.jobqueue.messaging.message.CancelMessage
setUuid(String) - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
setWorker(Object) - Method in class com.birbit.android.jobqueue.messaging.message.JobConsumerIdleMessage
setWorker(Object) - Method in class com.birbit.android.jobqueue.messaging.message.RunJobResultMessage
shouldCancelOnDeadline() - Method in class com.birbit.android.jobqueue.JobHolder
shouldCancelOnDeadline() - Method in class com.birbit.android.jobqueue.Params
shouldReRunOnThrowable(Throwable, int, int) - Method in class com.birbit.android.jobqueue.Job: If onRun method throws an exception, this method is called.
shouldRetry() - Method in class com.birbit.android.jobqueue.RetryConstraint
SimpleInMemoryPriorityQueue - Class in com.birbit.android.jobqueue.inMemoryQueue: A simple implementation of in memory JobQueue
SimpleInMemoryPriorityQueue(Configuration, long) - Constructor for class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
SINGLE_INSTANCE_ID_QUEUED - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used when a job was added while another job with the same single instance ID was already queued and not running.
SINGLE_INSTANCE_WHILE_RUNNING - Static variable in annotation type com.birbit.android.jobqueue.CancelReason: Used 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.
singleInstanceBy(String) - Method in class com.birbit.android.jobqueue.Params: Sets the single instance id.
SqlHelper - Class in com.birbit.android.jobqueue.persistentQueue.sqlite: Helper class for SqliteJobQueue to generate sql queries and statements.
SqlHelper(SQLiteDatabase, String, String, int, String, int, long) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
SqlHelper.ForeignKey - Class in com.birbit.android.jobqueue.persistentQueue.sqlite
SqlHelper.Order - Class in com.birbit.android.jobqueue.persistentQueue.sqlite
SqlHelper.Order.Type - Enum in com.birbit.android.jobqueue.persistentQueue.sqlite
SqlHelper.Property - Class in com.birbit.android.jobqueue.persistentQueue.sqlite
SqliteJobQueue - Class in com.birbit.android.jobqueue.persistentQueue.sqlite: Persistent Job Queue that keeps its data in an sqlite database.
SqliteJobQueue(Configuration, long, SqliteJobQueue.JobSerializer) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
SqliteJobQueue.JavaSerializer - Class in com.birbit.android.jobqueue.persistentQueue.sqlite
SqliteJobQueue.JobSerializer - Interface in com.birbit.android.jobqueue.persistentQueue.sqlite
start() - Method in class com.birbit.android.jobqueue.JobManager: Starts the JobManager if it is not already running.
START - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
START - Static variable in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
start(SchedulerConstraint) - Method in interface com.birbit.android.jobqueue.scheduling.Scheduler.Callback
start(SchedulerConstraint) - Method in class com.birbit.android.jobqueue.scheduling.Scheduler: Triggers the JobManager to handle the given constraint.
stop() - Method in class com.birbit.android.jobqueue.JobManager: Stops the JobManager.
STOP - Static variable in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
STOP - Static variable in class com.birbit.android.jobqueue.messaging.message.SchedulerMessage
stop() - Method in interface com.birbit.android.jobqueue.messaging.MessageQueue
stop() - Method in class com.birbit.android.jobqueue.messaging.PriorityMessageQueue
stop() - Method in class com.birbit.android.jobqueue.messaging.SafeMessageQueue
stop(SchedulerConstraint) - Method in interface com.birbit.android.jobqueue.scheduling.Scheduler.Callback
stop(SchedulerConstraint) - Method in class com.birbit.android.jobqueue.scheduling.Scheduler
stopAndWaitUntilConsumersAreFinished() - Method in class com.birbit.android.jobqueue.JobManager: Stops the JobManager and waits until all currently running Jobs are complete (or failed).
substitute(JobHolder, JobHolder) - Method in class com.birbit.android.jobqueue.cachedQueue.CachedJobQueue
substitute(JobHolder, JobHolder) - Method in class com.birbit.android.jobqueue.inMemoryQueue.SimpleInMemoryPriorityQueue
substitute(JobHolder, JobHolder) - Method in interface com.birbit.android.jobqueue.JobQueue: Remove the old job from the queue while inserting the new one.
substitute(JobHolder, JobHolder) - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqliteJobQueue
SystemTimer - Class in com.birbit.android.jobqueue.timer
SystemTimer() - Constructor for class com.birbit.android.jobqueue.timer.SystemTimer

T

TagConstraint - Enum in com.birbit.android.jobqueue
tags(Set<String>) - Method in class com.birbit.android.jobqueue.JobHolder.Builder
tags - Variable in class com.birbit.android.jobqueue.JobHolder
threadFactory(ThreadFactory) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: Provide a factory class to create new worker instances when JobManager needs them.
timer(Timer) - Method in class com.birbit.android.jobqueue.config.Configuration.Builder: You can specify a custom timer to control task execution.
Timer - Interface in com.birbit.android.jobqueue.timer
toString() - Method in class com.birbit.android.jobqueue.messaging.message.CommandMessage
toString() - Method in class com.birbit.android.jobqueue.messaging.message.PublicQueryMessage
toString() - Method in class com.birbit.android.jobqueue.scheduling.SchedulerConstraint
truncate() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
type - Variable in class com.birbit.android.jobqueue.messaging.Message
Type - Enum in com.birbit.android.jobqueue.messaging: All message types

U

unique - Variable in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Property
UNMETERED - Static variable in interface com.birbit.android.jobqueue.network.NetworkUtil

V

v(String, Object...) - Method in interface com.birbit.android.jobqueue.log.CustomLogger
v(String, Object...) - Method in class com.birbit.android.jobqueue.log.JqLog.ErrorLogger
v(String, Object...) - Static method in class com.birbit.android.jobqueue.log.JqLog
vacuum() - Method in class com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper
valueOf(String) - Static method in enum com.birbit.android.jobqueue.JobStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.birbit.android.jobqueue.messaging.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Order.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.birbit.android.jobqueue.TagConstraint: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.birbit.android.jobqueue.JobStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.birbit.android.jobqueue.messaging.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.birbit.android.jobqueue.persistentQueue.sqlite.SqlHelper.Order.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.birbit.android.jobqueue.TagConstraint: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitOnObject(Object) - Method in class com.birbit.android.jobqueue.timer.SystemTimer
waitOnObject(Object) - Method in interface com.birbit.android.jobqueue.timer.Timer
waitOnObjectUntilNs(Object, long) - Method in class com.birbit.android.jobqueue.timer.SystemTimer
waitOnObjectUntilNs(Object, long) - Method in interface com.birbit.android.jobqueue.timer.Timer
waitUntilAllMessagesAreConsumed(int) - Method in class com.birbit.android.jobqueue.CallbackManager: convenience method to wait for existing callbacks to be consumed
waitUntilConsumersAreFinished() - Method in class com.birbit.android.jobqueue.JobManager: Waits until all consumers are destroyed.
Where - Class in com.birbit.android.jobqueue.persistentQueue.sqlite
Where(long, String, String[]) - Constructor for class com.birbit.android.jobqueue.persistentQueue.sqlite.Where
willApplyNewDelayToGroup() - Method in class com.birbit.android.jobqueue.RetryConstraint: Returns whether the delay in this retry constraint will be applied to all jobs in this group.
WrongThreadException - Exception in com.birbit.android.jobqueue: Called when a method is called in the wrong thread.
WrongThreadException(String) - Constructor for exception com.birbit.android.jobqueue.WrongThreadException

A B C D E F G H I J L M N O P Q R S T U V W