Module de.focus_shift.jollyday.core
Package de.focus_shift.jollyday.core.spi

Interface HolidayCalendarConfiguration

public interface HolidayCalendarConfiguration
Represents the holiday calendar configuration, meta information like the hierarchy and description and the sub calendar configuration for a specific HolidayCalendar.
  • The `holidays` contains the holiday configuration for every holiday.
  • The `hierarchy` contains the ISO 3166-1 alpha-2 for countries or ISO 3166-2 code for subdivisions.
  • The `description` contains further information.
  • The `subConfiguration` contains the holiday configuration for subdivisions, cities, ... of the main configuration.

  • Method Details

    • hierarchy

      @NonNull String hierarchy()
      Contains the ISO 3166-1 alpha-2 for countries or ISO 3166-2 code for subdivisions
      Returns:
      the code of this configuration

    • description

      @NonNull String description()
      Contains further information like the name.
      Returns:
      the description of this configuration

    • holidays

      @NonNull HolidayConfigurations holidays()
      Contains all holiday configuration of different types like FixedHolidayConfiguration or ChristianHolidayConfiguration e.g.
      Returns:
      all holiday configuration for this HolidayCalendar

    • subConfigurations

      @NonNull Stream<HolidayCalendarConfiguration> subConfigurations()
      Contains the holiday configuration for subdivisions, cities, ... of the main configuration. The hierarchy is built on top of the iso standard. For germany e.g. there is a main configuration for Germany and 16 sub configurations for the subdivisions.
      Returns:
      all configurations for the next hierarchy level like subdivisions or cities.