com.atlassian.scheduler.caesium.cron.rule

Class CronExpression

java.lang.Object

com.atlassian.scheduler.caesium.cron.rule.CronExpression

All Implemented Interfaces:

CronRule, Serializable

public class CronExpression
extends Object
implements CronRule

Composes a set of parsed cron fields into a container that can evaluate all of them and find the next matching time for the expression.

Since:

v0.0.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CronExpression(String cronExpression, FieldRule year, FieldRule month, FieldRule day, FieldRule hour, FieldRule minute, FieldRule second)

Method Summary

Modifier and Type	Method and Description
boolean	first(DateTimeTemplate dateTime) Resets dateTime to the minimum matching value for this rule, if possible.
boolean	matches(DateTimeTemplate dateTime) Returns true if dateTime matches the rule; false if it does not.
boolean	next(DateTimeTemplate dateTime) Advance dateTime to when the rule would next match, if possible.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CronExpression

public CronExpression(String cronExpression,
                      FieldRule year,
                      FieldRule month,
                      FieldRule day,
                      FieldRule hour,
                      FieldRule minute,
                      FieldRule second)

Method Detail

matches

public boolean matches(DateTimeTemplate dateTime)

Description copied from interface: CronRule

Returns true if dateTime matches the rule; false if it does not.

Specified by:

matches in interface CronRule

Parameters:

dateTime - the moment to consider as a match for the rule

Returns:

true if dateTime matches the rule; false if it does not.

next

public boolean next(DateTimeTemplate dateTime)

Description copied from interface: CronRule

Advance dateTime to when the rule would next match, if possible.

Specified by:

next in interface CronRule

Parameters:

dateTime - the time to modify by changing the value that this rule evaluates to its next matching value

Returns:

true if dateTime has successfully been updated to when the rule would next match; false if all legal values have been exhausted for this rule (at least without some other rule changing dateTime in some other way first).

first

public boolean first(DateTimeTemplate dateTime)

Description copied from interface: CronRule

Resets dateTime to the minimum matching value for this rule, if possible.

Specified by:

first in interface CronRule

Parameters:

dateTime - the time to modify by resetting the value that this rule evaluates to its minimum matching value

Returns:

true if dateTime has successfully been updated to when the rule would first match; false if there are no matching values for this rule (at least without some other rule changing dateTime in some other way first).

toString

public String toString()

Overrides:

toString in class Object