Package ch.tocco.nice2.optional.calendar.api.recur

Interface RecurrenceBuilder

All Known Implementing Classes:
RecurrenceBuilderImpl
public interface RecurrenceBuilder
Builder for one Recurrence.

  • Method Details

    • build

      Recurrence build()
      Creates a new Recurrence from the specified information.

    • setUntil

      RecurrenceBuilder setUntil(DateTimeValue until)
      From RFC5545: 
       The UNTIL rule part defines a DATE or DATE-TIME value that bounds
 the recurrence rule in an inclusive manner.  If the value
 specified by UNTIL is synchronized with the specified recurrence,
 this DATE or DATE-TIME becomes the last instance of the
 recurrence. If not present, and the COUNT rule part is also not
 present, the "RRULE" is considered to repeat forever.

    • setCount

      RecurrenceBuilder setCount(int count)
      From RFC5545: 
       The COUNT rule part defines the number of occurrences at which to
 range-bound the recurrence.  The "DTSTART" property value always
 counts as the first occurrence.

    • setInterval

      RecurrenceBuilder setInterval(int interval)
      From RFC5545: 
        The INTERVAL rule part contains a positive integer representing at
  which intervals the recurrence rule repeats.  The default value is
  "1", meaning every second for a SECONDLY rule, every minute for a
  MINUTELY rule, every hour for an HOURLY rule, every day for a
  DAILY rule, every week for a WEEKLY rule, every month for a
  MONTHLY rule, and every year for a YEARLY rule.  For example,
  within a DAILY rule, a value of "8" means every eight days.

    • addBySecond

      RecurrenceBuilder addBySecond(int sec)
      From RFC5545: 
       The BYSECOND rule part specifies a COMMA-separated list of seconds
 within a minute.  Valid values are 0 to 60.

    • addByMinute

      RecurrenceBuilder addByMinute(int min)
      From RFC5545: 
        The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour.
  Valid values are 0 to 59.

    • addByHour

      RecurrenceBuilder addByHour(int hour)
      From RFC5545: 
       The BYHOUR rule part specifies a COMMA-separated list of hours of
 the day.  Valid values are 0 to 23.

    • addByWeekday

      RecurrenceBuilder addByWeekday(WeekdayItem weekdayItem)
      From RFC5545: 
       The BYDAY rule part specifies a COMMA-separated list of days of
 the week; SU indicates Sunday; MO indicates Monday; TU indicates
 Tuesday; WE indicates Wednesday; TH indicates Thursday; FR
 indicates Friday; and SA indicates Saturday.

 Each BYDAY value can also be preceded by a positive (+n) or
 negative (-n) integer.  If present, this indicates the nth
 occurrence of a specific day within the MONTHLY or YEARLY "RRULE".

 For example, within a MONTHLY rule, +1MO (or simply 1MO)
 represents the first Monday within the month, whereas -1MO
 represents the last Monday of the month.  The numeric value in a
 BYDAY rule part with the FREQ rule part set to YEARLY corresponds
 to an offset within the month when the BYMONTH rule part is
 present, and corresponds to an offset within the year when the
 BYWEEKNO or BYMONTH rule parts are present.  If an integer
 modifier is not present, it means all days of this type within the
 specified frequency.  For example, within a MONTHLY rule, MO
 represents all Mondays within the month.  The BYDAY rule part MUST
 NOT be specified with a numeric value when the FREQ rule part is
 not set to MONTHLY or YEARLY.  Furthermore, the BYDAY rule part
 MUST NOT be specified with a numeric value with the FREQ rule part
 set to YEARLY when the BYWEEKNO rule part is specified.
      Valid values: +/- 1..53[MO..SU]

    • addByMonthday

      RecurrenceBuilder addByMonthday(int dayofmonth)
      From RFC5545: 
       The BYMONTHDAY rule part specifies a COMMA-separated list of days
 of the month.  Valid values are 1 to 31 or -31 to -1.  For
 example, -10 represents the tenth to the last day of the month.
 The BYMONTHDAY rule part MUST NOT be specified when the FREQ rule
 part is set to WEEKLY.

    • addByYearday

      RecurrenceBuilder addByYearday(int dayofyear)
      From RFC5545: 
       The BYYEARDAY rule part specifies a COMMA-separated list of days
 of the year.  Valid values are 1 to 366 or -366 to -1.  For
 example, -1 represents the last day of the year (December 31st)
 and -306 represents the 306th to the last day of the year (March
 1st).  The BYYEARDAY rule part MUST NOT be specified when the FREQ
 rule part is set to DAILY, WEEKLY, or MONTHLY.

    • addByWeekNumber

      RecurrenceBuilder addByWeekNumber(int weeknumber)
      From RFC5545: The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. Valid values are 1 to 53 or -53 to -1. This corresponds to weeks according to week numbering as defined in [ISO.8601.2004]. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see WKST). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year. This rule part MUST NOT be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year.

    • addByMonth

      RecurrenceBuilder addByMonth(net.fortuna.ical4j.model.Month month)
      From RFC5545: 
       The BYMONTH rule part specifies a COMMA-separated list of months
 of the year.  Valid values are 1 to 12.

    • addBySetPosition

      RecurrenceBuilder addBySetPosition(int setpos)
      From RFC5545: 
       The BYSETPOS rule part specifies a COMMA-separated list of values
 that corresponds to the nth occurrence within the set of
 recurrence instances specified by the rule.  BYSETPOS operates on
 a set of recurrence instances in one interval of the recurrence
 rule.  For example, in a WEEKLY rule, the interval would be one
 week A set of recurrence instances starts at the beginning of the
 interval defined by the FREQ rule part.  Valid values are 1 to 366
 or -366 to -1.  It MUST only be used in conjunction with another
 BYxxx rule part.  For example "the last work day of the month"
 could be represented as:

  FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1

 Each BYSETPOS value can include a positive (+n) or negative (-n)
 integer.  If present, this indicates the nth occurrence of the
 specific occurrence within the set of occurrences specified by the
 rule.