public class RelativeDayOfWeekRule extends AnnualDateRule
For example, Good Friday can be specified as 'the Friday PRECEDING Easter Sunday'.
Constructor and Description |
---|
RelativeDayOfWeekRule()
Default constructor - builds a rule for the Monday following 1 January.
|
RelativeDayOfWeekRule(AnnualDateRule subrule,
int dayOfWeek,
int relative)
Standard constructor - builds rule based on the supplied sub-rule.
|
Modifier and Type | Method and Description |
---|---|
java.lang.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.
|
public RelativeDayOfWeekRule()
public RelativeDayOfWeekRule(AnnualDateRule subrule, int dayOfWeek, int relative)
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).public AnnualDateRule getSubrule()
public void setSubrule(AnnualDateRule subrule)
subrule
- the annual date rule that determines the reference date
for this rule.public int getDayOfWeek()
public void setDayOfWeek(int dayOfWeek)
dayOfWeek
- the day-of-the-week (SerialDate.MONDAY,
SerialDate.TUESDAY, and so on).public int getRelative()
public void setRelative(int relative)
relative
- determines *which* day-of-the-week is selected by this
rule.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class AnnualDateRule
java.lang.CloneNotSupportedException
- this should never happen.public SerialDate getDate(int year)
getDate
in class AnnualDateRule
year
- the year (1900 <= year <= 9999).null
).