com.evernote.android.job

Interface JobCreator

public interface JobCreator

A JobCreator maps a tag to a specific Job class. You need to pass the tag in the JobRequest.Builder constructor.

The JobManager can have multiple JobCreators with a first come first serve principle. That means that a JobCreator can block others from creating the right Job, if they share the same tag.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobCreator.AddJobCreatorReceiver Abstract receiver to get notified about when JobCreators need to be added.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_ADD_JOB_CREATOR Action to notify receives that the application was instantiated and JobCreators should be added.

Method Summary

Modifier and Type	Method and Description
Job	create(String tag) Map the tag to a Job.

Field Detail

ACTION_ADD_JOB_CREATOR

static final String ACTION_ADD_JOB_CREATOR

Action to notify receives that the application was instantiated and JobCreators should be added.

See Also:

Constant Field Values

Method Detail

create

@Nullable
Job create(@NonNull
                     String tag)

Map the tag to a Job. If you return null, then other JobCreators get the chance to create a Job for this tag. If no job is created at all, then it's assumed that job failed. This method is called on a background thread right before the job runs.

Parameters:

tag - The tag from the JobRequest which you passed in the constructor of the JobRequest.Builder class.

Returns:

A new Job instance for this tag. If you return null, then the job failed and isn't rescheduled.

See Also:

JobRequest.Builder#Builder(String)