com.atlassian.scheduler.caesium.impl

Class RunTimeCalculator

java.lang.Object

com.atlassian.scheduler.caesium.impl.RunTimeCalculator

public class RunTimeCalculator
extends Object

A utility for calculating the next run time for a given schedule.

Since:

v0.0.1

Constructor Summary

Constructors

Constructor and Description
RunTimeCalculator(com.atlassian.scheduler.core.spi.SchedulerServiceConfiguration config)

Method Summary

Modifier and Type	Method and Description
Date	firstRunTime(com.atlassian.scheduler.config.JobId jobId, com.atlassian.scheduler.config.JobConfig jobConfig) Calculates the first run time for the given job configuration.
Date	nextRunTime(com.atlassian.scheduler.config.Schedule schedule, Date prevRunTime) Calculates the next run time for the given schedule and previous run time.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunTimeCalculator

public RunTimeCalculator(com.atlassian.scheduler.core.spi.SchedulerServiceConfiguration config)

Method Detail

firstRunTime

@Nonnull
public Date firstRunTime(com.atlassian.scheduler.config.JobId jobId,
                                  com.atlassian.scheduler.config.JobConfig jobConfig)
                           throws com.atlassian.scheduler.SchedulerServiceException

Calculates the first run time for the given job configuration.

Parameters:

jobId - the job ID for which to calculate the first run time (used only for error reporting)

jobConfig - the new job's configuration

Returns:

the first time that the job will execute

Throws:

com.atlassian.scheduler.SchedulerServiceException - if the job will never run

nextRunTime

@Nullable
public Date nextRunTime(com.atlassian.scheduler.config.Schedule schedule,
                                  @Nullable
                                  Date prevRunTime)
                           throws com.atlassian.scheduler.cron.CronSyntaxException

Calculates the next run time for the given schedule and previous run time.

Parameters:

schedule - the job's schedule

prevRunTime - the job's previous run time, or null if it has never run previously

Returns:

the job's next run time, or null if it will never run again

Throws:

com.atlassian.scheduler.cron.CronSyntaxException - if the schedule uses a cron expression that is invalid