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.

    • 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]