com.cronutils.model.time

Class ExecutionTime

java.lang.Object

com.cronutils.model.time.ExecutionTime

public class ExecutionTime
extends Object

Calculates execution time given a cron pattern

Method Summary

Modifier and Type	Method and Description
static ExecutionTime	forCron(Cron cron) Creates execution time for given Cron
boolean	isMatch(org.joda.time.DateTime date) Provide feedback if a given date matches the cron expression.
org.joda.time.DateTime	lastExecution(org.joda.time.DateTime date) Provide nearest date for last execution.
org.joda.time.DateTime	nextExecution(org.joda.time.DateTime date) Provide nearest date for next execution.
org.joda.time.Duration	timeFromLastExecution(org.joda.time.DateTime date) Provide nearest time from last execution.
org.joda.time.Duration	timeToNextExecution(org.joda.time.DateTime date) Provide nearest time for next execution.

Methods inherited from class java.lang.Object

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

Method Detail

forCron

public static ExecutionTime forCron(Cron cron)

Creates execution time for given Cron

Parameters:

cron - - Cron instance

Returns:

ExecutionTime instance

nextExecution

public org.joda.time.DateTime nextExecution(org.joda.time.DateTime date)

Provide nearest date for next execution.

Parameters:

date - - jodatime DateTime instance. If null, a NullPointerException will be raised.

Returns:

DateTime instance, never null. Next execution time.

timeToNextExecution

public org.joda.time.Duration timeToNextExecution(org.joda.time.DateTime date)

Provide nearest time for next execution.

Parameters:

date - - jodatime DateTime instance. If null, a NullPointerException will be raised.

Returns:

jodatime Duration instance, never null. Time to next execution.

lastExecution

public org.joda.time.DateTime lastExecution(org.joda.time.DateTime date)

Provide nearest date for last execution.

Parameters:

date - - jodatime DateTime instance. If null, a NullPointerException will be raised.

Returns:

DateTime instance, never null. Last execution time.

timeFromLastExecution

public org.joda.time.Duration timeFromLastExecution(org.joda.time.DateTime date)

Provide nearest time from last execution.

Parameters:

date - - jodatime DateTime instance. If null, a NullPointerException will be raised.

Returns:

jodatime Duration instance, never null. Time from last execution.

isMatch

public boolean isMatch(org.joda.time.DateTime date)

Provide feedback if a given date matches the cron expression.

Parameters:

date - - jodatime DateTime instance. If null, a NullPointerException will be raised.

Returns:

true if date matches cron expression requirements, false otherwise.