com.atlassian.scheduler.caesium.cron.rule

Interface CronRule

All Superinterfaces:

Serializable

All Known Subinterfaces:

FieldRule

All Known Implementing Classes:

BitSetFieldRule, CronExpression, DayOfWeekFieldRule, RangeFieldRule, SingleValueFieldRule, SpecialDayOfMonthFieldRule, SpecialDayOfWeekLastFieldRule, SpecialDayOfWeekNthFieldRule

public interface CronRule
extends Serializable

Something that can evaluate a rule (or set of rules) for a given DateTimeTemplate to confirm whether or not it matches and advance to the next match that would satisfy it.

The rules themselves are stateless.

Since:

v0.0.1

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.

Method Detail

matches

boolean matches(DateTimeTemplate dateTime)

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

Parameters:

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

Returns:

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

first

boolean first(DateTimeTemplate dateTime)

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

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

next

boolean next(DateTimeTemplate dateTime)

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

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