de.aristaflow.adept2.util.time.nl

Interface PublicHolidays

All Known Implementing Classes:

LocalPublicHolidays, LocalPublicHolidays_de_DE, LocalPublicHolidays_de_DE_BW, LocalPublicHolidays_en

public interface PublicHolidays

Public holidays depend on the local conventions, therefore this interface encapsulates public holidays and provides methods on retrieving public holidays for a specific year, month or day.

The provided calendars in the methods refer to complete days, months or even years. Therefore implementations should ignore the timezone and the time as well as the day or month if appropriate. See CalendarTools.equals(Calendar, Calendar, int).

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPublicHolidayName(java.util.Calendar day) Returns the name of the public holiday represented by the designated calendar-instance.
java.util.Calendar[]	getPublicHolidaysForMonth(java.util.Calendar month) Returns the public holidays in the month represented by the designated calendar with respect to the local conventions.
java.util.Calendar[]	getPublicHolidaysForYear(java.util.Calendar year) Returns the public holidays in the year represented by the designated calendar with respect to the local conventions.
int[]	getWorkingWeekdays() Returns the day of weeks that are working days with respect to the local conventions.
boolean	isFloatingHoliday(java.util.Calendar day) Gets whether the designated calendar represents a day which is a public holiday with respect to the local conventions and if so, whether it is a floating holiday, meaning the day of the year changes every year (in contrast to a fixed holiday).
boolean	isPublicHoliday(java.util.Calendar day) Returns whether the designated calendar represents a day which is a public holiday with respect to the local conventions.
boolean	isWorkingDay(java.util.Calendar day) Returns whether the designated calendar represents a working day with respect to the local calendar, that is with respect to weekends and public holidays.

Method Detail

getWorkingWeekdays

int[] getWorkingWeekdays()

Returns the day of weeks that are working days with respect to the local conventions. The order corresponds to the normal order of days in the week and respects the Calendar.getFirstDayOfWeek().

Returns:

The day of weeks that are working days with respect to the local conventions.

isWorkingDay

boolean isWorkingDay(java.util.Calendar day)

Returns whether the designated calendar represents a working day with respect to the local calendar, that is with respect to weekends and public holidays.

Parameters:

day - A calendar representing a specific day.

Returns:

Whether the designated calendar represents a working day with respect to the local calendar with respect to weekends and public holidays.

isPublicHoliday

boolean isPublicHoliday(java.util.Calendar day)

Returns whether the designated calendar represents a day which is a public holiday with respect to the local conventions.

Parameters:

day - A calendar representing a specific day.

Returns:

Whether the designated calendar represents a public holiday with respect to the local public holidays.

isFloatingHoliday

boolean isFloatingHoliday(java.util.Calendar day)

Gets whether the designated calendar represents a day which is a public holiday with respect to the local conventions and if so, whether it is a floating holiday, meaning the day of the year changes every year (in contrast to a fixed holiday).

Parameters:

day - A calendar representing a specific day.

Returns:

Whether the designated calendar represents a public holiday which is floating, that is not every year on the same day.

getPublicHolidayName

java.lang.String getPublicHolidayName(java.util.Calendar day)

Returns the name of the public holiday represented by the designated calendar-instance. If the designated day is not a public holiday, null will be returned.

Parameters:

day - A calendar representing a specific day.

Returns:

The name of the public holiday if the designated day is a public holiday, otherwise null will be returned.

getPublicHolidaysForMonth

java.util.Calendar[] getPublicHolidaysForMonth(java.util.Calendar month)

Returns the public holidays in the month represented by the designated calendar with respect to the local conventions.

Parameters:

month - A calendar representing a month in a specific year.

Returns:

The days of the designated month which are public holidays with respect to the local public holidays. The array will be empty if there are no public holidays in the designated month.

getPublicHolidaysForYear

java.util.Calendar[] getPublicHolidaysForYear(java.util.Calendar year)

Returns the public holidays in the year represented by the designated calendar with respect to the local conventions.

Parameters:

year - A calendar representing a specific year.

Returns:

The days of the designated year which are public holidays with respect to the local public holidays. The array will be empty if there are no public holidays in the designated year.