com.ibm.icu.util
Interface DateRule
- EasterHoliday, HebrewHoliday, Holiday, RangeDateRule, SimpleDateRule, SimpleHoliday
public interface DateRule
DateRule is an interface for calculating the date of an event.
It supports both recurring events and those which occur only once.
DateRule is useful for storing information about holidays,
Daylight Savings Time rules, and other events such as meetings.
abstract Date | firstAfter(Date start) - Return the first occurrance of the event represented by this rule
that is on or after the given start date.
|
abstract Date | firstBetween(Date start, Date end) - Return the first occurrance of the event represented by this rule
that is on or after the given start date and before the given
end date.
|
abstract boolean | isBetween(Date start, Date end) - Check whether this event occurs at least once between the two
dates given.
|
abstract boolean | isOn(Date date) - Checks whether this event occurs on the given date.
|
firstAfter
public abstract Date firstAfter(Date start)
Return the first occurrance of the event represented by this rule
that is on or after the given start date.
start
- Only occurrances on or after this date are returned.
- The date on which this event occurs, or null if it
does not occur on or after the start date.
firstBetween
public abstract Date firstBetween(Date start,
Date end)
Return the first occurrance of the event represented by this rule
that is on or after the given start date and before the given
end date.
start
- Only occurrances on or after this date are returned.end
- Only occurrances before this date are returned.
- The date on which this event occurs, or null if it
does not occur between the start and end dates.
isBetween
public abstract boolean isBetween(Date start,
Date end)
Check whether this event occurs at least once between the two
dates given.
isOn
public abstract boolean isOn(Date date)
Checks whether this event occurs on the given date. This does
not take time of day into account; instead it checks
whether this event and the given date are on the same day.
This is useful for applications such as determining whether a given
day is a holiday.
date
- The date to check.
- true if this event occurs on the given date.
Copyright (c) 2006 IBM Corporation and others.