com.coreoz.wisp.schedule.cron

Class CronExpressionSchedule

java.lang.Object

com.coreoz.wisp.schedule.cron.CronExpressionSchedule

All Implemented Interfaces:

Schedule

public class CronExpressionSchedule
extends Object
implements Schedule

A Schedule based on a Cron expression.

This class depends on Cron library, so this dependency has to be in the classpath in order to be able to use CronExpressionSchedule. Since the Cron library is marked as optional in Wisp, it has to be explicitly referenced in the project dependency configuration (pom.xml, build.gradle, build.sbt etc.).

See also CronExpression for format details and implementation.

Field Summary

Fields inherited from interface com.coreoz.wisp.schedule.Schedule

WILL_NOT_BE_EXECUTED_AGAIN, willNeverBeExecuted

Constructor Summary

Constructors

Constructor and Description
CronExpressionSchedule(fc.cron.CronExpression cronExpression)
CronExpressionSchedule(fc.cron.CronExpression cronExpression, ZoneId zoneId)

Method Summary

Modifier and Type	Method and Description
long	nextExecutionInMillis(long currentTimeInMillis, int executionsCount, Long lastExecutionTimeInMillis) Compute the next execution time for a job.
static CronExpressionSchedule	parse(String cronExpression) Create a Schedule from a cron expression based on the Unix format, e.g. 1 * * * * for each minute.
static CronExpressionSchedule	parseWithSeconds(String cronExpression) Create a Schedule from a cron expression based on the Unix format, but accepting a second field as the first one, e.g. 29 * * * * * for each minute at the second 29, for instance 12:05:29.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CronExpressionSchedule

public CronExpressionSchedule(fc.cron.CronExpression cronExpression,
                              ZoneId zoneId)

CronExpressionSchedule

public CronExpressionSchedule(fc.cron.CronExpression cronExpression)

Method Detail

nextExecutionInMillis

public long nextExecutionInMillis(long currentTimeInMillis,
                                  int executionsCount,
                                  Long lastExecutionTimeInMillis)

Description copied from interface: Schedule

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

Specified by:

nextExecutionInMillis in interface Schedule

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

lastExecutionTimeInMillis - 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.

toString

public String toString()

Overrides:

toString in class Object

parse

public static CronExpressionSchedule parse(String cronExpression)

Create a Schedule from a cron expression based on the Unix format, e.g. 1 * * * * for each minute.

parseWithSeconds

public static CronExpressionSchedule parseWithSeconds(String cronExpression)

Create a Schedule from a cron expression based on the Unix format, but accepting a second field as the first one, e.g. 29 * * * * * for each minute at the second 29, for instance 12:05:29.