Class SimpleHoliday

java.lang.Object

com.ibm.icu.util.Holiday

com.ibm.icu.util.SimpleHoliday

All Implemented Interfaces:

DateRule

public class SimpleHoliday
extends Holiday

Note: The Holiday framework is a technology preview. Despite its age, is still draft API, and clients should treat it as such.

A holiday whose date can be represented by a month, day, and optionally day of week in the Gregorian calendar.

Status:

Draft ICU 2.8 (retainAll).

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleHoliday	ALL_SAINTS_DAY	All Saints' Day, November 1st
static final SimpleHoliday	ALL_SOULS_DAY	All Souls' Day, November 1st
static final SimpleHoliday	ASSUMPTION	Assumption, August 15th
static final SimpleHoliday	BOXING_DAY	Boxing Day, December 26th
static final SimpleHoliday	CHRISTMAS	Christmas, December 25th
static final SimpleHoliday	CHRISTMAS_EVE	Christmas Eve, December 24th
static final SimpleHoliday	EPIPHANY	Epiphany, January 6th
static final SimpleHoliday	IMMACULATE_CONCEPTION	Immaculate Conception, December 8th
static final SimpleHoliday	MAY_DAY	May Day, May 1st
static final SimpleHoliday	NEW_YEARS_DAY	New Year's Day - January 1st
static final SimpleHoliday	NEW_YEARS_EVE	New Year's Eve, December 31st
static final SimpleHoliday	ST_STEPHENS_DAY	Saint Stephen's Day, December 26th

Constructor Summary

Constructors

Constructor	Description
SimpleHoliday(int month, int dayOfMonth, int dayOfWeek, String name)	// TODO: remove Construct an object representing a holiday
SimpleHoliday(int month, int dayOfMonth, int dayOfWeek, String name, int startYear)
SimpleHoliday(int month, int dayOfMonth, int dayOfWeek, String name, int startYear, int endYear)
SimpleHoliday(int month, int dayOfMonth, String name)	Construct an object representing a holiday
SimpleHoliday(int month, int dayOfMonth, String name, int startYear)	Construct an object representing a holiday
SimpleHoliday(int month, int dayOfMonth, String name, int startYear, int endYear)	Construct an object representing a holiday

Method Summary

Methods inherited from class Holiday

firstAfter, firstBetween, getDisplayName, getDisplayName, getDisplayName, getHolidays, getHolidays, getHolidays, getRule, isBetween, isOn, setRule

Modifier and Type	Method	Description
Date	firstAfter(Date start)	Return the first occurrence of this holiday on or after the given date
Date	firstBetween(Date start, Date end)	Return the first occurrence of this holiday that is on or after the given start date and before the given end date.
String	getDisplayName()	Return the name of this holiday in the language of the default DISPLAY locale.
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.
String	getDisplayName(Locale locale)	Return the name of this holiday in the language of the specified locale.
static Holiday[]	getHolidays()
static Holiday[]	getHolidays(ULocale locale)
static Holiday[]	getHolidays(Locale locale)
DateRule	getRule()
boolean	isBetween(Date start, Date end)	Check whether this holiday occurs at least once between the two dates given.
boolean	isOn(Date date)	Checks whether this holiday falls on the given date.
void	setRule(DateRule rule)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NEW_YEARS_DAY

public static final SimpleHoliday NEW_YEARS_DAY

New Year's Day - January 1st

Status:

Draft ICU 2.8.

EPIPHANY

public static final SimpleHoliday EPIPHANY

Epiphany, January 6th

Status:

Draft ICU 2.8.

MAY_DAY

public static final SimpleHoliday MAY_DAY

May Day, May 1st

Status:

Draft ICU 2.8.

ASSUMPTION

public static final SimpleHoliday ASSUMPTION

Assumption, August 15th

Status:

Draft ICU 2.8.

ALL_SAINTS_DAY

public static final SimpleHoliday ALL_SAINTS_DAY

All Saints' Day, November 1st

Status:

Draft ICU 2.8.

ALL_SOULS_DAY

public static final SimpleHoliday ALL_SOULS_DAY

All Souls' Day, November 1st

Status:

Draft ICU 2.8.

IMMACULATE_CONCEPTION

public static final SimpleHoliday IMMACULATE_CONCEPTION

Immaculate Conception, December 8th

Status:

Draft ICU 2.8.

CHRISTMAS_EVE

public static final SimpleHoliday CHRISTMAS_EVE

Christmas Eve, December 24th

Status:

Draft ICU 2.8.

CHRISTMAS

public static final SimpleHoliday CHRISTMAS

Christmas, December 25th

Status:

Draft ICU 2.8.

BOXING_DAY

public static final SimpleHoliday BOXING_DAY

Boxing Day, December 26th

Status:

Draft ICU 2.8.

ST_STEPHENS_DAY

public static final SimpleHoliday ST_STEPHENS_DAY

Saint Stephen's Day, December 26th

Status:

Draft ICU 2.8.

NEW_YEARS_EVE

public static final SimpleHoliday NEW_YEARS_EVE

New Year's Eve, December 31st

Status:

Draft ICU 2.8.

Constructor Details

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 String name)

Construct an object representing a holiday

Parameters:

month - The month in which this holiday occurs (0-based)

dayOfMonth - The date within the month (1-based).

name - The name of this holiday. This string is used as a key to look up the holiday's name a resource bundle. If the name is not found in the resource bundle, getDisplayName will return this string instead.

See Also:

• Holiday.getDisplayName(java.util.Locale)

Status:

Draft ICU 2.8.

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 String name,
 int startYear)

Construct an object representing a holiday

Parameters:

month - The month in which this holiday occurs (0-based)

dayOfMonth - The date within the month (1-based).

name - The name of this holiday. This string is used as a key to look up the holiday's name a resource bundle. If the name is not found in the resource bundle, getDisplayName will return this string instead.

See Also:

• Holiday.getDisplayName(java.util.Locale)

Status:

Draft ICU 2.8.

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 String name,
 int startYear,
 int endYear)

Construct an object representing a holiday

Parameters:

month - The month in which this holiday occurs (0-based)

dayOfMonth - The date within the month (1-based).

name - The name of this holiday. This string is used as a key to look up the holiday's name a resource bundle. If the name is not found in the resource bundle, getDisplayName will return this string instead.

See Also:

• Holiday.getDisplayName(java.util.Locale)

Status:

Draft ICU 2.8.

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 int dayOfWeek,
 String name)

// TODO: remove Construct an object representing a holiday

Parameters:

month - The month in which this holiday occurs (0-based)

dayOfMonth - A date within the month (1-based). The interpretation of this parameter depends on the value of dayOfWeek.

dayOfWeek - The day of the week on which this holiday occurs. The following values are legal:

• dayOfWeek == 0 - use dayOfMonth only
• dayOfWeek < 0 - use last -dayOfWeek before or on dayOfMonth
• dayOfWeek > 0 - use first dayOfWeek after or on dayOfMonth

name - The name of this holiday. This string is used as a key to look up the holiday's name a resource bundle. If the name is not found in the resource bundle, getDisplayName will return this string instead.

See Also:

• Holiday.getDisplayName(java.util.Locale)

Status:

Draft ICU 2.8.

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 int dayOfWeek,
 String name,
 int startYear)

Status:

Draft ICU 2.8.

SimpleHoliday

public SimpleHoliday(int month,
 int dayOfMonth,
 int dayOfWeek,
 String name,
 int startYear,
 int endYear)

Status:

Draft ICU 2.8.