com.ibm.icu.util

Class Holiday

public abstract class Holiday extends Object implements DateRule

An abstract class representing a holiday.

UNKNOWN: ICU 2.8 (retainAll) This API might change or be removed in a future release.

Constructor Summary
protected Holiday(String name, DateRule rule)
Construct a new Holiday object.
Method Summary
DatefirstAfter(Date start)
Return the first occurrance of this holiday on or after the given date
DatefirstBetween(Date start, Date end)
Return the first occurrance of this holiday that is on or after the given start date and before the given end date.
StringgetDisplayName()
Return the name of this holiday in the language of the default locale
StringgetDisplayName(Locale locale)
Return the name of this holiday in the language of the specified locale The name parameter passed to this object's constructor is used as a key to look up the holiday's localized name in a ResourceBundle object named HolidayBundle.
StringgetDisplayName(ULocale locale)
Return the name of this holiday in the language of the specified locale The name parameter passed to this object's constructor is used as a key to look up the holiday's localized name in a ResourceBundle object named HolidayBundle.
static Holiday[]getHolidays()
static Holiday[]getHolidays(Locale locale)
static Holiday[]getHolidays(ULocale locale)
DateRulegetRule()
booleanisBetween(Date start, Date end)
Check whether this holiday occurs at least once between the two dates given.
booleanisOn(Date date)
Checks whether this holiday falls on the given date.
voidsetRule(DateRule rule)

Constructor Detail

Holiday

protected Holiday(String name, DateRule rule)
Construct a new Holiday object. This is for use by subclasses only. This constructs a new holiday with the given name and date rules.

Parameters: name The name of this holiday. The getDisplayName method uses this string as a key to look up the holiday's name a resource bundle object named HolidayBundle. rule The date rules used for determining when this holiday falls. Holiday's implementation of the DateRule inteface simply delegates to this DateRule object.

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

Method Detail

firstAfter

public Date firstAfter(Date start)
Return the first occurrance of this holiday on or after the given date

Parameters: start Only holidays on or after this date are returned.

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

See Also: Holiday

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

firstBetween

public Date firstBetween(Date start, Date end)
Return the first occurrance of this holiday 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: Holiday

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

getDisplayName

public String getDisplayName()
Return the name of this holiday in the language of the default locale

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

getDisplayName

public String getDisplayName(Locale locale)
Return the name of this holiday in the language of the specified locale The name parameter passed to this object's constructor is used as a key to look up the holiday's localized name in a ResourceBundle object named HolidayBundle.

Parameters: locale A locale specifying the language in which the name is desired.

See Also: ResourceBundle

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

getDisplayName

public String getDisplayName(ULocale locale)
Return the name of this holiday in the language of the specified locale The name parameter passed to this object's constructor is used as a key to look up the holiday's localized name in a ResourceBundle object named HolidayBundle.

Parameters: locale A locale specifying the language in which the name is desired.

See Also: ResourceBundle

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

getHolidays

public static Holiday[] getHolidays()

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

getHolidays

public static Holiday[] getHolidays(Locale locale)

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

getHolidays

public static Holiday[] getHolidays(ULocale locale)

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

getRule

public DateRule getRule()

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

isBetween

public boolean isBetween(Date start, Date end)
Check whether this holiday occurs at least once between the two dates given.

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

isOn

public boolean isOn(Date date)
Checks whether this holiday falls on the given date. This does not take time of day into account; instead it checks whether the holiday and the given date are on the same day.

Parameters: date The date to check.

Returns: true if this holiday occurs on the given date.

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

setRule

public void setRule(DateRule rule)

UNKNOWN: ICU 2.8 This API might change or be removed in a future release.

Copyright (c) 2006 IBM Corporation and others.