com.birbit.android.jobqueue

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

com.birbit.android.jobqueue.JobStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobStatus>

public enum JobStatus
extends java.lang.Enum<JobStatus>

Identifies the current status of a job if it is in the queue

Enum Constant Summary

Enum Constants

Enum Constant and Description
RUNNING Job is being executed by one of the runners.
UNKNOWN Job is not known by job queue.
WAITING_NOT_READY Job is in the queue but cannot run yet.
WAITING_READY Job is in the queue, ready to be run.

Method Summary

Modifier and Type	Method and Description
static JobStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobStatus[]	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

WAITING_NOT_READY

public static final JobStatus WAITING_NOT_READY

Job is in the queue but cannot run yet. As of v 1.1, this might be:

• Job requires network but there is no available network connection
• Job is delayed. We are waiting for the time to pass

WAITING_READY

public static final JobStatus WAITING_READY

Job is in the queue, ready to be run. Waiting for an available consumer.

RUNNING

public static final JobStatus RUNNING

Job is being executed by one of the runners.

UNKNOWN

public static final JobStatus UNKNOWN

Job is not known by job queue.

This might be:

• Invalid ID
• Job has been completed
• Job has failed
• Job has just been added, about to be delivered into a queue

Method Detail

values

public static JobStatus[] 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 (JobStatus c : JobStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static JobStatus valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null