com.evernote.android.job

Class Job

java.lang.Object

com.evernote.android.job.Job

public abstract class Job
extends java.lang.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
protected 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.
static boolean	completeWakefulIntent(android.content.Intent intent) Delegates calls to WakefulBroadcastReceiver#completeWakefulIntent(Intent).
boolean	equals(java.lang.Object o)
protected android.content.Context	getContext()
protected Job.Params	getParams()
int	hashCode()
protected boolean	isCanceled()
boolean	isFinished()
protected boolean	isRequirementChargingMet()
protected boolean	isRequirementDeviceIdleMet()
protected boolean	isRequirementNetworkTypeMet()
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.
protected android.content.ComponentName	startWakefulService(android.content.Intent intent) Delegates calls to WakefulBroadcastReceiver#startWakefulService(Context, Intent).
java.lang.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

protected abstract Job.Result onRunJob(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.

onReschedule

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.

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.

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.

getParams

protected final Job.Params getParams()

Returns:

The same parameters like passed to onRunJob(Params).

getContext

protected final android.content.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.

isCanceled

protected final boolean isCanceled()

Returns:

true if this Job was canceled.

isFinished

public final boolean isFinished()

Returns:

true if the Job finished.

startWakefulService

protected android.content.ComponentName startWakefulService(android.content.Intent intent)

Delegates calls to WakefulBroadcastReceiver#startWakefulService(Context, Intent).

Do a Context.startService, but holding a wake lock while the service starts. This will modify the Intent to hold an extra identifying the wake lock; when the service receives it in Service.onStartCommand, it should pass back the Intent it receives there to completeWakefulIntent(android.content.Intent) in order to release the wake lock.

Parameters:

intent - The Intent with which to start the service, as per Context.startService.

See Also:

WakefulBroadcastReceiver

completeWakefulIntent

public static boolean completeWakefulIntent(android.content.Intent intent)

Delegates calls to WakefulBroadcastReceiver#completeWakefulIntent(Intent).

Finish the execution from a previous startWakefulService(android.content.Intent). Any wake lock that was being held will now be released.

Parameters:

intent - The Intent as originally generated by startWakefulService(android.content.Intent).

Returns:

Returns true if the intent is associated with a wake lock that is now released; returns false if there was no wake lock specified for it.

See Also:

WakefulBroadcastReceiver

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object