de.aristaflow.adept2.util.time.nl

Class LocalPublicHolidays

java.lang.Object

de.aristaflow.adept2.util.time.nl.LocalPublicHolidays

All Implemented Interfaces:

PublicHolidays

Direct Known Subclasses:

LocalPublicHolidays_de_DE, LocalPublicHolidays_en

public class LocalPublicHolidays
extends java.lang.Object
implements PublicHolidays

This class is used as default for public holidays. It provides default implementations for all methods of the PublicHolidays-interface but it does not have any holidays at all.

Author:

Ulrich Kreher

Constructor Summary

Constructors

Constructor and Description
LocalPublicHolidays()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<CalendarTools.DayOfYear,java.lang.String>	getFixedHolidays() Provides the local fixed public holidays (without a year) including their names.
protected java.util.Map<java.util.Calendar,java.lang.String>	getFixedHolidays(java.util.Calendar year) Returns the fixed holidays as Calendar-instances with respect to the year specified by the designated calendar.
protected java.util.Map<java.util.Calendar,java.lang.String>	getFloatingHolidays(java.util.Calendar year) Provides the local floating holidays in the designated year including their names.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPublicHolidays

public LocalPublicHolidays()

Method Detail

getFixedHolidays

protected java.util.Map<CalendarTools.DayOfYear,java.lang.String> getFixedHolidays()

Provides the local fixed public holidays (without a year) including their names.
This implementation does provide an empty map and is therefore to be overridden.

Returns:

A map containing the fixed public holidays (without a year) and the corresponding names.

getFloatingHolidays

protected java.util.Map<java.util.Calendar,java.lang.String> getFloatingHolidays(java.util.Calendar year)

Provides the local floating holidays in the designated year including their names.
This implementation does provide an empty map and is therefore to be overridden.

Parameters:

year - A calendar specifying the year of which to retrieve the floating holidays.

Returns:

A map containing the floating holidays for the designated year and the corresponding names.

getFixedHolidays

protected java.util.Map<java.util.Calendar,java.lang.String> getFixedHolidays(java.util.Calendar year)

Returns the fixed holidays as Calendar-instances with respect to the year specified by the designated calendar. GregorianCalendars are used with UTC as timezone and a time of one minute after midnight. Override this method in case of another calendar system or timezone.

Parameters:

year - The calendar specifying the year of which to retrieve the fixed holidays.

Returns:

A map containing all fixed holidays for the designated years and their corresponding (local) names.

getWorkingWeekdays

public int[] getWorkingWeekdays()

Description copied from interface: PublicHolidays

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().

Specified by:

getWorkingWeekdays in interface PublicHolidays

Returns:

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

isWorkingDay

public boolean isWorkingDay(java.util.Calendar day)

Description copied from interface: PublicHolidays

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

Specified by:

isWorkingDay in interface PublicHolidays

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

public boolean isPublicHoliday(java.util.Calendar day)

Description copied from interface: PublicHolidays

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

Specified by:

isPublicHoliday in interface PublicHolidays

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

public boolean isFloatingHoliday(java.util.Calendar day)

Description copied from interface: PublicHolidays

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).

Specified by:

isFloatingHoliday in interface PublicHolidays

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

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

Description copied from interface: PublicHolidays

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.

Specified by:

getPublicHolidayName in interface PublicHolidays

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

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

Description copied from interface: PublicHolidays

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

Specified by:

getPublicHolidaysForMonth in interface PublicHolidays

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

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

Description copied from interface: PublicHolidays

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

Specified by:

getPublicHolidaysForYear in interface PublicHolidays

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.