org.sellcom.geotemporal.time.applicability

Class TemporalApplicability

java.lang.Object

org.sellcom.geotemporal.time.applicability.GeoTemporalApplicability

org.sellcom.geotemporal.time.applicability.TemporalApplicability

All Implemented Interfaces:

BiPredicate<Temporal,GeoRegion>, Predicate<Temporal>, GeoTemporalPredicate, TemporalPredicate

public abstract class TemporalApplicability
extends GeoTemporalApplicability
implements TemporalPredicate

Applicability at a Temporal.

Since:

1.0

See Also:

Temporal

Constructor Summary

Constructors

Constructor and Description
TemporalApplicability()

Method Summary

Modifier and Type	Method and Description
static TemporalApplicability	always() Creates an applicability that is always satisfied.
static TemporalApplicability	dateRange(LocalDate startDate, LocalDate endDate) Creates an applicability satisfied in the given range of dates.
static TemporalApplicability	dayOfWeekAfter(int ordinal, DayOfWeek dayOfWeek, MonthDay monthDay) Creates an applicability satisfied on the ordinal-th day-of-week after the given month-day.
static TemporalApplicability	dayOfWeekBefore(int ordinal, DayOfWeek dayOfWeek, MonthDay monthDay) Creates an applicability satisfied on the ordinal-th day-of-week before the given month-day.
static TemporalApplicability	dayOfWeekRange(DayOfWeek startDayOfWeek, DayOfWeek endDayOfWeek) Creates an applicability satisfied in the given days-of-week.
static TemporalApplicability	evenIsoWeek() Creates an applicability satisfied in weeks with an even ISO week number.
static TemporalApplicability	isoWeekRange(int startWeekNumber, int endWeekNumber) Creates an applicability satisfied in weeks with the week number in the given range.
static TemporalApplicability	monthDayRange(MonthDay startMonthDay, MonthDay endMonthDay) Creates an applicability satisfied in the given range of month-days.
static TemporalApplicability	monthRange(Month startMonth, Month endMonth) Creates an applicability satisfied in the given range of months.
TemporalApplicability	negate()
static TemporalApplicability	never() Creates an applicability that is never satisfied.
static TemporalApplicability	oddIsoWeek() Creates an applicability satisfied in weeks with an odd ISO week number.
static TemporalApplicability	singleDate(LocalDate date) Creates an applicability satisfied on the given date.
static TemporalApplicability	singleDayOfWeek(DayOfWeek dayOfWeek) Creates an applicability satisfied on the given day-of-week.
static TemporalApplicability	singleIsoWeek(int weekNumber) Creates an applicability satisfied in weeks with the given ISO week number.
static TemporalApplicability	singleMonth(Month month) Creates an applicability satisfied in the given month.
static TemporalApplicability	singleMonthDay(MonthDay monthDay) Creates an applicability satisfied on the given month-day.
static TemporalApplicability	singleYear(int year) Creates an applicability satisfied in the given year.
static TemporalApplicability	singleYear(Year year) Creates an applicability satisfied in the given year.
abstract boolean	test(Temporal temporal) Checks whether this applicability is satisfied at the given temporal.
boolean	test(Temporal temporal, GeoRegion region) Checks whether this applicability is satisfied at the given temporal in the given region.
static TemporalApplicability	yearRange(int startYear, int endYear) Creates an applicability satisfied in the given range of years.
static TemporalApplicability	yearRange(Year startYear, Year endYear) Creates an applicability satisfied in the given range of years.

Methods inherited from class org.sellcom.geotemporal.time.applicability.GeoTemporalApplicability

holiday, parse, publicHoliday, schoolHoliday, weekend

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, or

Methods inherited from interface java.util.function.BiPredicate

and, or

Constructor Detail

TemporalApplicability

public TemporalApplicability()

Method Detail

always

public static TemporalApplicability always()

Creates an applicability that is always satisfied.

Since:

1.0

dateRange

public static TemporalApplicability dateRange(LocalDate startDate,
                                              LocalDate endDate)

Creates an applicability satisfied in the given range of dates. Both the start date and the end date are inclusive.

Throws:

IllegalArgumentException - if startDate is null

IllegalArgumentException - if endDate is null

Since:

1.0

dayOfWeekAfter

public static TemporalApplicability dayOfWeekAfter(int ordinal,
                                                   DayOfWeek dayOfWeek,
                                                   MonthDay monthDay)

Creates an applicability satisfied on the ordinal-th day-of-week after the given month-day.

Throws:

IllegalArgumentException - if ordinal is 0

IllegalArgumentException - if dayOfWeek is null

IllegalArgumentException - if monthDay is null

Since:

1.0

dayOfWeekBefore

public static TemporalApplicability dayOfWeekBefore(int ordinal,
                                                    DayOfWeek dayOfWeek,
                                                    MonthDay monthDay)

Creates an applicability satisfied on the ordinal-th day-of-week before the given month-day.

Throws:

IllegalArgumentException - if ordinal is 0

IllegalArgumentException - if dayOfWeek is null

IllegalArgumentException - if monthDay is null

Since:

1.0

dayOfWeekRange

public static TemporalApplicability dayOfWeekRange(DayOfWeek startDayOfWeek,
                                                   DayOfWeek endDayOfWeek)

Creates an applicability satisfied in the given days-of-week. Both the start day-of-week and the end day-of-week are inclusive and the range may wrap around the end of the week.

Throws:

IllegalArgumentException - if startDayOfWeek is null

IllegalArgumentException - if endDayOfWeek is null

Since:

1.0

evenIsoWeek

public static TemporalApplicability evenIsoWeek()

Creates an applicability satisfied in weeks with an even ISO week number.

Since:

1.0

isoWeekRange

public static TemporalApplicability isoWeekRange(int startWeekNumber,
                                                 int endWeekNumber)

Creates an applicability satisfied in weeks with the week number in the given range. Both the start week number and the end week number are inclusive.

Since:

1.0

monthDayRange

public static TemporalApplicability monthDayRange(MonthDay startMonthDay,
                                                  MonthDay endMonthDay)

Creates an applicability satisfied in the given range of month-days. Both the start month-day and the end month-day are inclusive and the range may wrap around the end of the year.

Throws:

IllegalArgumentException - if startMonthDay is null

IllegalArgumentException - if endMonthDay is null

Since:

1.0

monthRange

public static TemporalApplicability monthRange(Month startMonth,
                                               Month endMonth)

Creates an applicability satisfied in the given range of months. Both the start month and the end month are inclusive and the range may wrap around the end of the year.

Throws:

IllegalArgumentException - if startMonth is null

IllegalArgumentException - if endMonth is null

Since:

1.0

negate

public TemporalApplicability negate()

Specified by:

negate in interface BiPredicate<Temporal,GeoRegion>

Specified by:

negate in interface Predicate<Temporal>

never

public static TemporalApplicability never()

Creates an applicability that is never satisfied.

Since:

1.0

oddIsoWeek

public static TemporalApplicability oddIsoWeek()

Creates an applicability satisfied in weeks with an odd ISO week number.

Since:

1.0

singleDate

public static TemporalApplicability singleDate(LocalDate date)

Creates an applicability satisfied on the given date.

Throws:

IllegalArgumentException - if date is null

Since:

1.0

singleDayOfWeek

public static TemporalApplicability singleDayOfWeek(DayOfWeek dayOfWeek)

Creates an applicability satisfied on the given day-of-week.

Throws:

IllegalArgumentException - if dayOfWeek is null

Since:

1.0

singleIsoWeek

public static TemporalApplicability singleIsoWeek(int weekNumber)

Creates an applicability satisfied in weeks with the given ISO week number.

Throws:

IllegalArgumentException - if weekNumber is not positive

IllegalArgumentException - if weekNumber is greater than 53

Since:

1.0

singleMonth

public static TemporalApplicability singleMonth(Month month)

Creates an applicability satisfied in the given month.

Throws:

IllegalArgumentException - if month is null

Since:

1.0

singleMonthDay

public static TemporalApplicability singleMonthDay(MonthDay monthDay)

Creates an applicability satisfied on the given month-day.

Throws:

IllegalArgumentException - if monthDay is null

Since:

1.0

singleYear

public static TemporalApplicability singleYear(int year)

Creates an applicability satisfied in the given year.

Since:

1.0

singleYear

public static TemporalApplicability singleYear(Year year)

Creates an applicability satisfied in the given year.

Throws:

IllegalArgumentException - if year is null

Since:

1.0

test

public abstract boolean test(Temporal temporal)

Checks whether this applicability is satisfied at the given temporal.

Specified by:

test in interface Predicate<Temporal>

Specified by:

test in interface TemporalPredicate

Throws:

IllegalArgumentException - if temporal is null

Since:

1.0

test

public final boolean test(Temporal temporal,
                          GeoRegion region)

Description copied from class: GeoTemporalApplicability

Checks whether this applicability is satisfied at the given temporal in the given region.

Specified by:

test in interface BiPredicate<Temporal,GeoRegion>

Specified by:

test in interface GeoTemporalPredicate

Specified by:

test in class GeoTemporalApplicability

yearRange

public static TemporalApplicability yearRange(int startYear,
                                              int endYear)

Creates an applicability satisfied in the given range of years. Both the start year and the end year are inclusive.

Since:

1.0

yearRange

public static TemporalApplicability yearRange(Year startYear,
                                              Year endYear)

Creates an applicability satisfied in the given range of years. Both the start year and the end year are inclusive.

Throws:

IllegalArgumentException - if startYear is null

IllegalArgumentException - if endYear is null

Since:

1.0