com.evernote.android.job

Class Job

java.lang.Object

com.evernote.android.job.Job

Direct Known Subclasses:

DailyJob

public abstract class Job
extends Object

Base class for running delayed jobs. A Job is executed in a background thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.Params Holds several parameters for the Job execution.
static class	Job.Result

Constructor Summary

Constructors

Constructor and Description
Job()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this Job if it hasn't finished, yet.
(package private) void	cancel(boolean deleted)
boolean	equals(Object o)
protected Context	getContext()
(package private) long	getFinishedTimeStamp()
protected Job.Params	getParams()
(package private) Job.Result	getResult()
int	hashCode()
protected boolean	isCanceled()
(package private) boolean	isDeleted()
boolean	isFinished()
protected boolean	isRequirementBatteryNotLowMet()
protected boolean	isRequirementChargingMet()
protected boolean	isRequirementDeviceIdleMet()
protected boolean	isRequirementNetworkTypeMet()
protected boolean	isRequirementStorageNotLowMet()
protected boolean	meetsRequirements() Checks all requirements for this job.
(package private) boolean	meetsRequirements(boolean checkRequirementsEnforced)
protected void	onCancel() This method is intended to be overwritten.
protected void	onReschedule(int newJobId) This method is called if you returned Job.Result.RESCHEDULE in onRunJob(Params) and the Job was successfully rescheduled.
protected abstract Job.Result	onRunJob(Job.Params params) This method is invoked from a background thread.
(package private) Job.Result	runJob()
(package private) Job	setContext(Context context)
(package private) Job	setRequest(JobRequest request, Bundle transientExtras)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Job

public Job()

Method Detail

onRunJob

@NonNull
 @WorkerThread
protected abstract Job.Result onRunJob(@NonNull
                                                               Job.Params params)

This method is invoked from a background thread. You should run your desired task here. This method is thread safe. Each time a job starts executing a new instance of your Job is instantiated. You can identify your Job with the passed params.

You should call isCanceled() frequently for long running jobs and stop your task if necessary.

A PowerManager.WakeLock is acquired for 3 minutes for each Job. If your task needs more time, then you need to create an extra PowerManager.WakeLock.

Parameters:

params - The parameters for this concrete job.

Returns:

The result of this Job. Note that returning Job.Result.RESCHEDULE for a periodic Job is invalid and ignored.

onCancel

protected void onCancel()

This method is intended to be overwritten. It is called once when the job is still running, but was canceled. This can happen when the system wants to stop the job or if you manually cancel the job yourself. It's a good indicator to stop your work and maybe retry your job later again. Alternatively, you can also call isCanceled().

See Also:

isCanceled()

runJob

final Job.Result runJob()

onReschedule

@WorkerThread
protected void onReschedule(int newJobId)

This method is called if you returned Job.Result.RESCHEDULE in onRunJob(Params) and the Job was successfully rescheduled. The new rescheduled JobRequest has a new ID. Override this method if you want to be notified about the change.

Parameters:

newJobId - The new ID of the rescheduled JobRequest.

meetsRequirements

protected boolean meetsRequirements()

Checks all requirements for this job. It's also possible to check all requirements separately with the corresponding methods.

Returns:

Whether all set requirements are met.

meetsRequirements

boolean meetsRequirements(boolean checkRequirementsEnforced)

isRequirementChargingMet

protected boolean isRequirementChargingMet()

Returns:

false if the Job requires the device to be charging and it isn't charging. Otherwise always returns true.

isRequirementDeviceIdleMet

protected boolean isRequirementDeviceIdleMet()

Returns:

false if the Job requires the device to be idle and it isn't idle. Otherwise always returns true.

isRequirementBatteryNotLowMet

protected boolean isRequirementBatteryNotLowMet()

Returns:

Whether the battery not low requirement is met. That's true either if it's not a requirement or if the battery actually isn't low. The battery is low, if less than 15% are left and the device isn't charging.

isRequirementStorageNotLowMet

protected boolean isRequirementStorageNotLowMet()

Returns:

Whether the storage not low requirement is met. That's true either if it's not a requirement or if the storage actually isn't low.

isRequirementNetworkTypeMet

protected boolean isRequirementNetworkTypeMet()

Returns:

false if the Job requires the device to be in a specific network state and it isn't in this state. Otherwise always returns true.

setRequest

final Job setRequest(JobRequest request,
                     @NonNull
                     Bundle transientExtras)

getParams

@NonNull
protected final Job.Params getParams()

Returns:

The same parameters like passed to onRunJob(Params).

setContext

final Job setContext(Context context)

getContext

@NonNull
protected final Context getContext()

Returns:

The Context running this Job. In most situations it's a Service. If this context already was destroyed for some reason, then the application context is returned. Never returns null.

cancel

public final void cancel()

Cancel this Job if it hasn't finished, yet.

cancel

final void cancel(boolean deleted)

isCanceled

protected final boolean isCanceled()

Returns:

true if this Job was canceled.

isFinished

public final boolean isFinished()

Returns:

true if the Job finished.

getFinishedTimeStamp

final long getFinishedTimeStamp()

getResult

final Job.Result getResult()

isDeleted

final boolean isDeleted()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object