org.jfree.date
Class RelativeDayOfWeekRule
- Cloneable
An annual date rule that returns a date for each year based on (a) a
reference rule; (b) a day of the week; and (c) a selection parameter
(SerialDate.PRECEDING, SerialDate.NEAREST, SerialDate.FOLLOWING).
For example, Good Friday can be specified as 'the Friday PRECEDING Easter
Sunday'.
Object | clone() - Creates a clone of this rule.
|
SerialDate | getDate(int year) - Returns the date generated by this rule, for the specified year.
|
int | getDayOfWeek() - Returns the day-of-the-week for this rule.
|
int | getRelative() - Returns the 'relative' attribute, that determines *which*
day-of-the-week we are interested in (SerialDate.PRECEDING,
SerialDate.NEAREST or SerialDate.FOLLOWING).
|
AnnualDateRule | getSubrule() - Returns the sub-rule (also called the reference rule).
|
void | setDayOfWeek(int dayOfWeek) - Sets the day-of-the-week for this rule.
|
void | setRelative(int relative) - Sets the 'relative' attribute (SerialDate.PRECEDING, SerialDate.NEAREST,
SerialDate.FOLLOWING).
|
void | setSubrule(AnnualDateRule subrule) - Sets the sub-rule.
|
RelativeDayOfWeekRule
public RelativeDayOfWeekRule()
Default constructor - builds a rule for the Monday following 1 January.
RelativeDayOfWeekRule
public RelativeDayOfWeekRule(AnnualDateRule subrule,
int dayOfWeek,
int relative)
Standard constructor - builds rule based on the supplied sub-rule.
subrule
- the rule that determines the reference date.dayOfWeek
- the day-of-the-week relative to the reference date.relative
- indicates *which* day-of-the-week (preceding, nearest
or following).
clone
public Object clone()
throws CloneNotSupportedException
Creates a clone of this rule.
- clone in interface AnnualDateRule
getDate
public SerialDate getDate(int year)
Returns the date generated by this rule, for the specified year.
- getDate in interface AnnualDateRule
year
- the year (1900 <= year <= 9999).
- The date generated by the rule for the given year (possibly
null
).
getDayOfWeek
public int getDayOfWeek()
Returns the day-of-the-week for this rule.
- the day-of-the-week for this rule.
getRelative
public int getRelative()
Returns the 'relative' attribute, that determines *which*
day-of-the-week we are interested in (SerialDate.PRECEDING,
SerialDate.NEAREST or SerialDate.FOLLOWING).
- The 'relative' attribute.
getSubrule
public AnnualDateRule getSubrule()
Returns the sub-rule (also called the reference rule).
- The annual date rule that determines the reference date for this
rule.
setDayOfWeek
public void setDayOfWeek(int dayOfWeek)
Sets the day-of-the-week for this rule.
dayOfWeek
- the day-of-the-week (SerialDate.MONDAY,
SerialDate.TUESDAY, and so on).
setRelative
public void setRelative(int relative)
Sets the 'relative' attribute (SerialDate.PRECEDING, SerialDate.NEAREST,
SerialDate.FOLLOWING).
relative
- determines *which* day-of-the-week is selected by this
rule.
setSubrule
public void setSubrule(AnnualDateRule subrule)
Sets the sub-rule.
subrule
- the annual date rule that determines the reference date
for this rule.