Module de.focus_shift.jollyday.core

Package de.focus_shift.jollyday.core.spi

Interface Limited

All Known Subinterfaces:

ChristianHolidayConfiguration, EthiopianOrthodoxHolidayConfiguration, FixedHolidayConfiguration, FixedWeekdayBetweenFixedHolidayConfiguration, FixedWeekdayInMonthHolidayConfiguration, FixedWeekdayRelativeToFixedHolidayConfiguration, IslamicHolidayConfiguration, RelativeToEasterSundayHolidayConfiguration, RelativeToFixedHolidayConfiguration, RelativeToWeekdayInMonthHolidayConfiguration

public interface Limited

Provides the functionality to limit the years a holiday will occur. By default, a holiday will occur on every year it is requested until this interface will be used and valid from or valid to is set, then the holiday will only occur in this year's. If the cycle is set, a holiday will only occur in the years represented by the cycle.

Example: if a holiday is only valid from 1900 until 1910 and a cycle from five years is configured, then the holiday will occur in the years:

• 1900
• 1905
• 1910

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Limited.YearCycle

Method Summary

Modifier and Type	Method	Description
@NonNull Limited.YearCycle	cycle()	Describes the cycle a holiday is valid in between the years given bei from and to.
@NonNull Optional<Year>	validFrom()	Describes the first year a holiday is valid (inclusive)
@NonNull Optional<Year>	validTo()	Describes the last year a holiday is valid (inclusive)

Method Details

validFrom

@NonNull Optional<Year> validFrom()

Describes the first year a holiday is valid (inclusive)

Returns:

the first valid year of a holiday

validTo

@NonNull Optional<Year> validTo()

Describes the last year a holiday is valid (inclusive)

Returns:

the last valid year of a holiday

cycle

@NonNull Limited.YearCycle cycle()

Describes the cycle a holiday is valid in between the years given bei from and to.

Returns:

the cycle to limit a holiday between from and to