Class Schedule.Builder

    • Method Detail

      • set

        public Schedule.Builder set​(java.lang.String propertyName,
                                    java.lang.Object newValue)
      • periods

        public Schedule.Builder periods​(java.util.List<SchedulePeriod> periods)
        Sets the schedule periods.

        There will be at least one period. The periods are ordered from earliest to latest. It is intended that each period is adjacent to the next one, however each period is independent and non-adjacent periods are allowed.

        Parameters:
        periods - the new value, not empty
        Returns:
        this, for chaining, not null
      • periods

        public Schedule.Builder periods​(SchedulePeriod... periods)
        Sets the periods property in the builder from an array of objects.
        Parameters:
        periods - the new value, not empty
        Returns:
        this, for chaining, not null
      • frequency

        public Schedule.Builder frequency​(Frequency frequency)
        Sets the periodic frequency used when building the schedule.

        If the schedule was not built from a regular periodic frequency, then the frequency should be a suitable estimate.

        Parameters:
        frequency - the new value, not null
        Returns:
        this, for chaining, not null
      • rollConvention

        public Schedule.Builder rollConvention​(RollConvention rollConvention)
        Sets the roll convention used when building the schedule.

        If the schedule was not built from a regular periodic frequency, then the convention should be 'None'.

        Parameters:
        rollConvention - the new value, not null
        Returns:
        this, for chaining, not null