com.evernote.android.job

Enum Job.Result

java.lang.Object

java.lang.Enum<Job.Result>

com.evernote.android.job.Job.Result

All Implemented Interfaces:

Serializable, Comparable<Job.Result>

Enclosing class:

Job

public static enum Job.Result
extends Enum<Job.Result>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILURE Indicates that Job.onRunJob(Params) failed, but the Job shouldn't be rescheduled.
RESCHEDULE Indicates that Job.onRunJob(Params) failed and the Job should be rescheduled with the defined back-off criteria.
SUCCESS Indicates that Job.onRunJob(Params) was successful.

Method Summary

Modifier and Type	Method and Description
static Job.Result	valueOf(String name) Returns the enum constant of this type with the specified name.
static Job.Result[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final Job.Result SUCCESS

Indicates that Job.onRunJob(Params) was successful.

FAILURE

public static final Job.Result FAILURE

Indicates that Job.onRunJob(Params) failed, but the Job shouldn't be rescheduled.

Periodic jobs will continue to run. The failure count of the job is incremented, what can be helpful in the next interval.

See Also:

Job.Params.getFailureCount()

RESCHEDULE

public static final Job.Result RESCHEDULE

Indicates that Job.onRunJob(Params) failed and the Job should be rescheduled with the defined back-off criteria. Note that returning RESCHEDULE for a periodic Job is invalid and ignored.

Returning RESCHEDULE for periodic jobs has the same effect as returning FAILURE.

Method Detail

values

public static Job.Result[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Job.Result c : Job.Result.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Job.Result valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null