com.coreoz.wisp.schedule

Interface Schedule

All Known Implementing Classes:

AfterInitialDelaySchedule, CronExpressionSchedule, CronSchedule, FixedDelaySchedule, FixedHourSchedule, OnceSchedule

public interface Schedule

Provide the time of the next executions of a job. The implementations should be thread-safe. Moreover the same instance of a schedule should be usable on multiple jobs.

Field Summary

Fields

Modifier and Type	Field and Description
static long	WILL_NOT_BE_EXECUTED_AGAIN If the nextExecutionInMillis(long, int, Long) returned value is -1, then the corresponding job will not be executed again.
static Schedule	willNeverBeExecuted A schedule that will always return WILL_NOT_BE_EXECUTED_AGAIN.

Method Summary

Modifier and Type	Method and Description
long	nextExecutionInMillis(long currentTimeInMillis, int executionsCount, Long lastExecutionEndedTimeInMillis) Compute the next execution time for a job.

Field Detail

WILL_NOT_BE_EXECUTED_AGAIN

static final long WILL_NOT_BE_EXECUTED_AGAIN

If the nextExecutionInMillis(long, int, Long) returned value is -1, then the corresponding job will not be executed again.

See Also:

Constant Field Values

willNeverBeExecuted

static final Schedule willNeverBeExecuted

A schedule that will always return WILL_NOT_BE_EXECUTED_AGAIN.

Method Detail

nextExecutionInMillis

long nextExecutionInMillis(long currentTimeInMillis,
                           int executionsCount,
                           Long lastExecutionEndedTimeInMillis)

Compute the next execution time for a job. This method should be thread-safe.

Parameters:

currentTimeInMillis - The current time in milliseconds. This time must be used if a next execution is planned for the job

executionsCount - The number of times a job has already been executed

lastExecutionEndedTimeInMillis - The time at which the job has last been executed; will be null if the job has never been executed

Returns:

The time in milliseconds at which the job should execute next. This time must be relative to currentTimeInMillis. If the returned value is negative, the job will not be executed again.