com.atlassian.scheduler.caesium.cron.rule.field

Interface FieldRule

All Superinterfaces:

CronRule, Serializable

All Known Implementing Classes:

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

public interface FieldRule
extends CronRule

A container for a field value that can modify its value according to whatever constraints were defined in a cron expression.

Since:

v0.0.1

Method Summary

Modifier and Type	Method and Description
int	get(DateTimeTemplate dateTime) Returns the currently set value for this field.
void	set(DateTimeTemplate dateTime, int value) Modifies the value for this field to produce a new moment for consideration.

Methods inherited from interface com.atlassian.scheduler.caesium.cron.rule.CronRule

first, matches, next

Method Detail

get

int get(DateTimeTemplate dateTime)

Returns the currently set value for this field.

Parameters:

dateTime - the moment from which to extract this field's value

Returns:

the value for this field as currently set in dateTime

set

void set(DateTimeTemplate dateTime,
         int value)

Modifies the value for this field to produce a new moment for consideration.

Parameters:

dateTime - the moment to modify

value - the value to set for this field