com.firebase.jobdispatcher

Class Job.Builder

java.lang.Object

com.firebase.jobdispatcher.Job.Builder

All Implemented Interfaces:

JobParameters

Enclosing class:

Job

public static final class Job.Builder
extends java.lang.Object
implements JobParameters

A class that understands how to build a Job. Retrieved by calling FirebaseJobDispatcher.newJobBuilder().

Method Summary

Modifier and Type	Method and Description
Job.Builder	addConstraint(int constraint) Adds the provided constraint to the current list of runtime constraints.
Job	build() Builds the Job, using the settings provided so far.
int[]	getConstraints() The runtime constraints applied to this Job.
android.os.Bundle	getExtras() The optional set of user-supplied extras associated with this Job.
int	getLifetime() The Job's lifetime; how long it should persist for.
RetryStrategy	getRetryStrategy() The RetryStrategy for the Job.
java.lang.String	getService() Returns the name of the backing JobService class.
java.lang.String	getTag() Returns a string identifier for the Job.
JobTrigger	getTrigger() The Job's Trigger, which decides when the Job is ready to run.
TriggerReason	getTriggerReason()
boolean	isRecurring() Whether the Job should repeat.
Job.Builder	setConstraints(int... constraints) Sets the Job's runtime constraints.
Job.Builder	setExtras(android.os.Bundle extras) Sets the user-defined extras associated with the Job.
Job.Builder	setLifetime(int lifetime) Sets the Job's lifetime, or how long it should persist.
Job.Builder	setRecurring(boolean recurring) Sets whether the job should recur.
Job.Builder	setReplaceCurrent(boolean replaceCurrent) Sets whether this Job should replace pre-existing Jobs with the same tag.
Job.Builder	setRetryStrategy(RetryStrategy retryStrategy) Set the RetryStrategy used for the Job.
Job.Builder	setService(java.lang.Class<? extends JobService> serviceClass) Sets the backing JobService class for the Job.
Job.Builder	setTag(java.lang.String tag) Sets the unique String tag used to identify the Job.
Job.Builder	setTrigger(JobTrigger trigger) Sets the Trigger used for the Job.
boolean	shouldReplaceCurrent() Whether the Job should replace a pre-existing Job with the same tag.

Methods inherited from class java.lang.Object

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

Method Detail

addConstraint

public Job.Builder addConstraint(int constraint)

Adds the provided constraint to the current list of runtime constraints.

setReplaceCurrent

public Job.Builder setReplaceCurrent(boolean replaceCurrent)

Sets whether this Job should replace pre-existing Jobs with the same tag.

build

public Job build()

Builds the Job, using the settings provided so far.

Throws:

ValidationEnforcer.ValidationException

getService

public java.lang.String getService()

Returns the name of the backing JobService class.

Specified by:

getService in interface JobParameters

setService

public Job.Builder setService(java.lang.Class<? extends JobService> serviceClass)

Sets the backing JobService class for the Job. See getService().

getTag

public java.lang.String getTag()

Returns a string identifier for the Job. Used when cancelling Jobs and displaying debug messages.

Specified by:

getTag in interface JobParameters

setTag

public Job.Builder setTag(java.lang.String tag)

Sets the unique String tag used to identify the Job. See getTag().

getTrigger

public JobTrigger getTrigger()

The Job's Trigger, which decides when the Job is ready to run.

Specified by:

getTrigger in interface JobParameters

setTrigger

public Job.Builder setTrigger(JobTrigger trigger)

Sets the Trigger used for the Job. See getTrigger().

getLifetime

public int getLifetime()

The Job's lifetime; how long it should persist for.

Specified by:

getLifetime in interface JobParameters

setLifetime

public Job.Builder setLifetime(int lifetime)

Sets the Job's lifetime, or how long it should persist. See getLifetime().

isRecurring

public boolean isRecurring()

Whether the Job should repeat.

Specified by:

isRecurring in interface JobParameters

setRecurring

public Job.Builder setRecurring(boolean recurring)

Sets whether the job should recur. The default is false.

getConstraints

public int[] getConstraints()

The runtime constraints applied to this Job. A Job is not run until the trigger is activated and all the runtime constraints are satisfied.

Specified by:

getConstraints in interface JobParameters

setConstraints

public Job.Builder setConstraints(int... constraints)

Sets the Job's runtime constraints. See getConstraints().

getExtras

public android.os.Bundle getExtras()

The optional set of user-supplied extras associated with this Job.

Specified by:

getExtras in interface JobParameters

setExtras

public Job.Builder setExtras(android.os.Bundle extras)

Sets the user-defined extras associated with the Job. See getExtras().

getRetryStrategy

public RetryStrategy getRetryStrategy()

The RetryStrategy for the Job. Used to determine how to handle failures.

Specified by:

getRetryStrategy in interface JobParameters

setRetryStrategy

public Job.Builder setRetryStrategy(RetryStrategy retryStrategy)

Set the RetryStrategy used for the Job. See getRetryStrategy().

shouldReplaceCurrent

public boolean shouldReplaceCurrent()

Whether the Job should replace a pre-existing Job with the same tag.

Specified by:

shouldReplaceCurrent in interface JobParameters

getTriggerReason

public TriggerReason getTriggerReason()

Specified by:

getTriggerReason in interface JobParameters

Returns:

A TriggerReason that - if non null - describes why the job was triggered.