Class JobCheckOptions

java.lang.Object

org.mineskin.JobCheckOptions

All Implemented Interfaces:

IJobCheckOptions

public final class JobCheckOptions
extends Object
implements IJobCheckOptions

Example:

    JobCheckOptions.create()
          .withUseEta()
          .withInterval(RequestInterval.exponential())
          .withMaxAttempts(50)

Constructor Summary

Constructors

Constructor	Description
JobCheckOptions(ScheduledExecutorService scheduler, int intervalMillis, int initialDelayMillis, int maxAttempts)	Deprecated.
JobCheckOptions(ScheduledExecutorService scheduler, int intervalMillis, int initialDelayMillis, int maxAttempts, boolean useEta)	Deprecated.
JobCheckOptions(ScheduledExecutorService scheduler, RequestInterval interval, int initialDelayMillis, int maxAttempts, boolean useEta)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static JobCheckOptions	create()	Creates a JobCheckOptions instance with default values.
static JobCheckOptions	create(ScheduledExecutorService scheduler)	Creates a JobCheckOptions instance with default values.
int	initialDelayMillis()
RequestInterval	interval()
int	intervalMillis()	Deprecated.
int	maxAttempts()
ScheduledExecutorService	scheduler()
boolean	useEta()
JobCheckOptions	withInitialDelay(int initialDelayMillis)
JobCheckOptions	withInitialDelay(int initialDelay, TimeUnit unit)
JobCheckOptions	withInterval(RequestInterval interval)
JobCheckOptions	withMaxAttempts(int maxAttempts)
JobCheckOptions	withUseEta()	Sets the option to use the estimated completion time provided by the server to schedule the first check.

Methods inherited from class Object

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

Constructor Details

JobCheckOptions

@Deprecated
public JobCheckOptions(ScheduledExecutorService scheduler,
 RequestInterval interval,
 int initialDelayMillis,
 int maxAttempts,
 boolean useEta)

Deprecated.

Parameters:

scheduler - Executor service to run the job checks - this should be a single-threaded scheduler

interval - Interval strategy between each request, see RequestInterval

initialDelayMillis - Initial delay in milliseconds before the first job check, default is 2000

maxAttempts - Maximum number of attempts to check the job status, default is 10

useEta - Whether to use the estimated completion time provided by the server to schedule the first check, default is false

JobCheckOptions

@Deprecated
public JobCheckOptions(ScheduledExecutorService scheduler,
 int intervalMillis,
 int initialDelayMillis,
 int maxAttempts,
 boolean useEta)

Deprecated.

Parameters:

scheduler - Executor service to run the job checks - this should be a single-threaded scheduler

intervalMillis - Interval in milliseconds between each job check, default is 1000

initialDelayMillis - Initial delay in milliseconds before the first job check, default is 2000

maxAttempts - Maximum number of attempts to check the job status, default is 10

useEta - Whether to use the estimated completion time provided by the server to schedule the first check, default is false

JobCheckOptions

@Deprecated
public JobCheckOptions(ScheduledExecutorService scheduler,
 int intervalMillis,
 int initialDelayMillis,
 int maxAttempts)

Deprecated.

Method Details

create

public static JobCheckOptions create(ScheduledExecutorService scheduler)

Creates a JobCheckOptions instance with default values.

create

public static JobCheckOptions create()

Creates a JobCheckOptions instance with default values.

withInterval

public JobCheckOptions withInterval(RequestInterval interval)

withInitialDelay

public JobCheckOptions withInitialDelay(int initialDelayMillis)

withInitialDelay

public JobCheckOptions withInitialDelay(int initialDelay,
 TimeUnit unit)

withMaxAttempts

public JobCheckOptions withMaxAttempts(int maxAttempts)

withUseEta

public JobCheckOptions withUseEta()

Sets the option to use the estimated completion time provided by the server to schedule the first check.

scheduler

public ScheduledExecutorService scheduler()

Specified by:

scheduler in interface IJobCheckOptions

interval

public RequestInterval interval()

Specified by:

interval in interface IJobCheckOptions

intervalMillis

@Deprecated
public int intervalMillis()

Deprecated.

Specified by:

intervalMillis in interface IJobCheckOptions

initialDelayMillis

public int initialDelayMillis()

Specified by:

initialDelayMillis in interface IJobCheckOptions

maxAttempts

public int maxAttempts()

Specified by:

maxAttempts in interface IJobCheckOptions

useEta

public boolean useEta()

Specified by:

useEta in interface IJobCheckOptions