com.ibm.icu.util

Interface DateRule

All Known Implementing Classes:

EasterHoliday, HebrewHoliday, Holiday, RangeDateRule, SimpleDateRule, SimpleHoliday

public interface DateRule

Note: The Holiday framework is a technology preview. Despite its age, is still draft API, and clients should treat it as such. 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.

See Also:

SimpleDateRule

Status:

Draft ICU 2.8 (retainAll).

Method Summary

Modifier and Type	Method and Description
Date	firstAfter(Date start) Return the first occurrance of the event represented by this rule that is on or after the given start date.
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.
boolean	isBetween(Date start, Date end) Check whether this event occurs at least once between the two dates given.
boolean	isOn(Date date) Checks whether this event occurs on the given date.

Method Detail

firstAfter

Date firstAfter(Date start)

Return the first occurrance of the event represented by this rule that is on or after the given start date.

Parameters:

start - Only occurrances on or after this date are returned.

Returns:

The date on which this event occurs, or null if it does not occur on or after the start date.

See Also:

firstBetween(java.util.Date, java.util.Date)

Status:

Draft ICU 2.8.

firstBetween

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.

Parameters:

start - Only occurrances on or after this date are returned.

end - Only occurrances before this date are returned.

Returns:

The date on which this event occurs, or null if it does not occur between the start and end dates.

See Also:

firstAfter(java.util.Date)

Status:

Draft ICU 2.8.

isOn

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.

Parameters:

date - The date to check.

Returns:

true if this event occurs on the given date.

Status:

Draft ICU 2.8.

isBetween

boolean isBetween(Date start,
                  Date end)

Check whether this event occurs at least once between the two dates given.

Status:

Draft ICU 2.8.