com.birbit.android.jobqueue.scheduling

Class SchedulerConstraint

java.lang.Object

com.birbit.android.jobqueue.scheduling.SchedulerConstraint

public class SchedulerConstraint
extends java.lang.Object

The constraints that are passed into Scheduler from JobManager

Constructor Summary

Constructors

Constructor and Description
SchedulerConstraint(java.lang.String uuid)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getData()
long	getDelayInMs() The delay for the job
int	getNetworkStatus()
java.lang.Long	getOverrideDeadlineInMs() The deadline in ms after which the job should be run even if the constraints are not match.
java.lang.String	getUuid() The unique id assigned by the job manager.
void	setData(java.lang.Object data)
void	setDelayInMs(long delayInMs)
void	setNetworkStatus(int networkStatus)
void	setOverrideDeadlineInMs(java.lang.Long overrideDeadlineInMs)
void	setUuid(java.lang.String uuid)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SchedulerConstraint

public SchedulerConstraint(java.lang.String uuid)

Method Detail

getUuid

public java.lang.String getUuid()

The unique id assigned by the job manager. This is different from the ID that is assigned by the third party scheduler.

Returns:

The unique id assigned by the job manager

setUuid

public void setUuid(java.lang.String uuid)

getDelayInMs

public long getDelayInMs()

The delay for the job

Returns:

The delay before running the job

setDelayInMs

public void setDelayInMs(long delayInMs)

getNetworkStatus

public int getNetworkStatus()

Returns:

The network status required to run the job.

setNetworkStatus

public void setNetworkStatus(int networkStatus)

getData

public java.lang.Object getData()

setData

public void setData(java.lang.Object data)

getOverrideDeadlineInMs

@Nullable
public java.lang.Long getOverrideDeadlineInMs()

The deadline in ms after which the job should be run even if the constraints are not match.

If there is no deadline, this will be null.

Returns:

The time in ms until the constraints timeout

setOverrideDeadlineInMs

public void setOverrideDeadlineInMs(java.lang.Long overrideDeadlineInMs)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object