JobHolder (jobqueue API)

java.lang.Object
- com.birbit.android.jobqueue.JobHolder

```
public class JobHolder
extends java.lang.Object
```
Container class to address Jobs inside job manager.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JobHolder.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobHolder.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`groupId`
`java.lang.String`	`id`
`boolean`	`persistent`
`static int`	`RUN_RESULT_FAIL_FOR_CANCEL` Internal constant.
`static int`	`RUN_RESULT_FAIL_RUN_LIMIT` Internal constant.
`static int`	`RUN_RESULT_FAIL_SHOULD_RE_RUN` The job decided not to run in shouldReRun method.
`static int`	`RUN_RESULT_FAIL_SINGLE_ID` Internal constant.
`static int`	`RUN_RESULT_HIT_DEADLINE` Internal constant.
`static int`	`RUN_RESULT_SUCCESS` Internal constant.
`static int`	`RUN_RESULT_TRY_AGAIN` Internal constant.
`protected java.util.Set<java.lang.String>`	`tags`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`long`	`getCreatedNs()`
`long`	`getDeadlineNs()`
`long`	`getDelayUntilNs()`
`java.lang.String`	`getGroupId()`
`java.lang.String`	`getId()`
`java.lang.Long`	`getInsertionOrder()`
`Job`	`getJob()`
`int`	`getPriority()`
`int`	`getRequiredNetworkType()` Returns the type of network required by this job.
`RetryConstraint`	`getRetryConstraint()`
`int`	`getRunCount()`
`long`	`getRunningSessionId()`
`java.lang.String`	`getSingleInstanceId()`
`java.util.Set<java.lang.String>`	`getTags()`
`boolean`	`hasDeadline()`
`boolean`	`hasDelay()`
`int`	`hashCode()`
`boolean`	`hasTags()`
`boolean`	`isCancelled()`
`boolean`	`isCancelledSingleId()`
`void`	`markAsCancelled()`
`void`	`markAsCancelledSingleId()`
`void`	`onCancel(int cancelReason)`
`void`	`setApplicationContext(android.content.Context applicationContext)`
`void`	`setDeadlineIsReached(boolean didReachDeadline)`
`void`	`setDelayUntilNs(long delayUntilNs)`
`void`	`setInsertionOrder(long insertionOrder)`
`void`	`setPriority(int priority)`
`void`	`setRunCount(int runCount)`
`void`	`setRunningSessionId(long runningSessionId)`
`boolean`	`shouldCancelOnDeadline()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RUN_RESULT_SUCCESS
```
public static final int RUN_RESULT_SUCCESS
```
    Internal constant. Job's onRun method completed w/o any exception.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_FAIL_RUN_LIMIT
```
public static final int RUN_RESULT_FAIL_RUN_LIMIT
```
    Internal constant. Job's onRun method thrown an exception and either it does not want to run again or reached retry limit.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_FAIL_FOR_CANCEL
```
public static final int RUN_RESULT_FAIL_FOR_CANCEL
```
    Internal constant. Job's onRun method has thrown an exception and it was cancelled after it started.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_TRY_AGAIN
```
public static final int RUN_RESULT_TRY_AGAIN
```
    Internal constant. Job's onRun method failed but wants to retry.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_FAIL_SHOULD_RE_RUN
```
public static final int RUN_RESULT_FAIL_SHOULD_RE_RUN
```
    The job decided not to run in shouldReRun method.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_FAIL_SINGLE_ID
```
public static final int RUN_RESULT_FAIL_SINGLE_ID
```
    Internal constant. Job's onRun method has thrown an exception and another job with the same single instance id had been queued.
    
    See Also:
    
    Constant Field Values
  - RUN_RESULT_HIT_DEADLINE
```
public static final int RUN_RESULT_HIT_DEADLINE
```
    Internal constant. Used when job's onRun method has thrown an exception and it hit its cancel deadline.
    
    See Also:
    
    Constant Field Values
  - id
```
public final java.lang.String id
```
  - persistent
```
public final boolean persistent
```
  - groupId
```
public final java.lang.String groupId
```
  - tags
```
protected final java.util.Set<java.lang.String> tags
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
  - getSingleInstanceId
```
public final java.lang.String getSingleInstanceId()
```
  - getPriority
```
public int getPriority()
```
  - setPriority
```
public void setPriority(int priority)
```
  - getInsertionOrder
```
public java.lang.Long getInsertionOrder()
```
  - setInsertionOrder
```
public void setInsertionOrder(long insertionOrder)
```
  - setDelayUntilNs
```
public void setDelayUntilNs(long delayUntilNs)
```
  - getRunCount
```
public int getRunCount()
```
  - setRunCount
```
public void setRunCount(int runCount)
```
  - getCreatedNs
```
public long getCreatedNs()
```
  - getRunningSessionId
```
public long getRunningSessionId()
```
  - setRunningSessionId
```
public void setRunningSessionId(long runningSessionId)
```
  - getDeadlineNs
```
public long getDeadlineNs()
```
  - shouldCancelOnDeadline
```
public boolean shouldCancelOnDeadline()
```
  - getDelayUntilNs
```
public long getDelayUntilNs()
```
  - getJob
```
public Job getJob()
```
  - getGroupId
```
public java.lang.String getGroupId()
```
  - getTags
```
public java.util.Set<java.lang.String> getTags()
```
  - markAsCancelled
```
public void markAsCancelled()
```
  - isCancelled
```
public boolean isCancelled()
```
  - markAsCancelledSingleId
```
public void markAsCancelledSingleId()
```
  - isCancelledSingleId
```
public boolean isCancelledSingleId()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hasTags
```
public boolean hasTags()
```
  - setApplicationContext
```
public void setApplicationContext(android.content.Context applicationContext)
```
  - setDeadlineIsReached
```
public void setDeadlineIsReached(boolean didReachDeadline)
```
  - hasDeadline
```
public boolean hasDeadline()
```
  - hasDelay
```
public boolean hasDelay()
```
  - onCancel
```
public void onCancel(int cancelReason)
```
  - getRetryConstraint
```
public RetryConstraint getRetryConstraint()
```
  - getRequiredNetworkType
```
public int getRequiredNetworkType()
```
    Returns the type of network required by this job.
    Note that these network status can be compared to eachother and higher network type is a larger requirement. For instance, if this method returns NetworkUtil.DISCONNECTED, that does not mean job requires no network to run. Instead, it means it does not require any network to run.
    
    Returns:
    
    The minimum type of network connection that is required to run this job.

Class JobHolder

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RUN_RESULT_SUCCESS

RUN_RESULT_FAIL_RUN_LIMIT

RUN_RESULT_FAIL_FOR_CANCEL

RUN_RESULT_TRY_AGAIN

RUN_RESULT_FAIL_SHOULD_RE_RUN

RUN_RESULT_FAIL_SINGLE_ID

RUN_RESULT_HIT_DEADLINE

id

persistent

groupId

tags

Method Detail

getId

getSingleInstanceId

getPriority

setPriority

getInsertionOrder

setInsertionOrder

setDelayUntilNs

getRunCount

setRunCount

getCreatedNs

getRunningSessionId

setRunningSessionId

getDeadlineNs

shouldCancelOnDeadline

getDelayUntilNs

getJob

getGroupId

getTags

markAsCancelled

isCancelled

markAsCancelledSingleId

isCancelledSingleId

hashCode

equals

hasTags

setApplicationContext

setDeadlineIsReached

hasDeadline

hasDelay

onCancel

getRetryConstraint

getRequiredNetworkType