org.sellcom.geotemporal.time

Class Temporals

java.lang.Object

org.sellcom.geotemporal.time.Temporals

public class Temporals
extends Object

Operations with Temporals.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static int	getIsoWeekNumber(Temporal temporal) Returns the ISO 8601 week number of the given temporal.
static boolean	isHoliday(Temporal temporal, GeoRegion region, EnumSet<HolidayType> types) Checks whether the given temporal is a holiday of any of the given types in the given region.
static boolean	isPublicHoliday(Temporal temporal, GeoRegion region) Checks whether the given temporal is a public holiday in the given region.
static boolean	isSchoolHoliday(Temporal temporal, GeoRegion region) Checks whether the given date is a school holiday in the given region.
static boolean	isWeekend(Temporal temporal, GeoRegion region) Checks whether the given temporal is a weekend in the given region.
static boolean	isWorkingDay(Temporal temporal, GeoRegion region) Checks whether the given temporal is a working day in the given region.
static void	registerCustomHolidayPredicate(String countryCode, HolidayPredicate predicate) Registers a custom predicate for determining holidays in the given country.
static void	registerCustomWeekendPredicate(String countryCode, GeoTemporalPredicate predicate) Registers a custom predicate for determining weekends in the given country.
static void	registerCustomWorkingDayPredicate(String countryCode, GeoTemporalPredicate predicate) Registers a custom predicate for determining working days in the given country.

Methods inherited from class java.lang.Object

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

Method Detail

getIsoWeekNumber

public static int getIsoWeekNumber(Temporal temporal)

Returns the ISO 8601 week number of the given temporal.

Throws:

IllegalArgumentException - if temporal is null

Since:

1.0

isHoliday

public static boolean isHoliday(Temporal temporal,
                                GeoRegion region,
                                EnumSet<HolidayType> types)

Checks whether the given temporal is a holiday of any of the given types in the given region.

Throws:

IllegalArgumentException - if temporal is null

IllegalArgumentException - if region is null

IllegalArgumentException - if types is null

GeoRegionNotSupportedException - if the region is not supported

Since:

1.0

isPublicHoliday

public static boolean isPublicHoliday(Temporal temporal,
                                      GeoRegion region)

Checks whether the given temporal is a public holiday in the given region.

Only considers public holidays (HolidayType.PUBLIC). To customise the holiday types, use isHoliday(Temporal, GeoRegion, EnumSet) instead.

Throws:

IllegalArgumentException - if temporal is null

IllegalArgumentException - if region is null

GeoRegionNotSupportedException - if the region is not supported

Since:

1.0

isSchoolHoliday

public static boolean isSchoolHoliday(Temporal temporal,
                                      GeoRegion region)

Checks whether the given date is a school holiday in the given region.

Only considers school holidays (HolidayType.SCHOOLS_AND_UNIVERSITIES_ONLY and HolidayType.SCHOOLS_ONLY). To customise the holiday types, use isHoliday(Temporal, GeoRegion, EnumSet) instead.

Throws:

IllegalArgumentException - if temporal is null

IllegalArgumentException - if region is null

GeoRegionNotSupportedException - if the region is not supported

Since:

1.0

isWeekend

public static boolean isWeekend(Temporal temporal,
                                GeoRegion region)

Checks whether the given temporal is a weekend in the given region.

Throws:

IllegalArgumentException - if temporal is null

IllegalArgumentException - if region is null

GeoRegionNotSupportedException - if the region is not supported

Since:

1.0

isWorkingDay

public static boolean isWorkingDay(Temporal temporal,
                                   GeoRegion region)

Checks whether the given temporal is a working day in the given region.

Throws:

IllegalArgumentException - if temporal is null

IllegalArgumentException - if region is null

GeoRegionNotSupportedException - if the region is not supported

Since:

1.0

registerCustomHolidayPredicate

public static void registerCustomHolidayPredicate(String countryCode,
                                                  HolidayPredicate predicate)

Registers a custom predicate for determining holidays in the given country.

Throws:

IllegalArgumentException - if countryCode is null

IllegalArgumentException - if predicate is null

Since:

1.0

registerCustomWeekendPredicate

public static void registerCustomWeekendPredicate(String countryCode,
                                                  GeoTemporalPredicate predicate)

Registers a custom predicate for determining weekends in the given country.

Throws:

IllegalArgumentException - if countryCode is null

IllegalArgumentException - if predicate is null

Since:

1.0

registerCustomWorkingDayPredicate

public static void registerCustomWorkingDayPredicate(String countryCode,
                                                     GeoTemporalPredicate predicate)

Registers a custom predicate for determining working days in the given country.

Throws:

IllegalArgumentException - if countryCode is null

IllegalArgumentException - if predicate is null

Since:

1.0