3.3.10. Recurrence Rule
Value Name: RECUR
Purpose: This value type is used to identify properties that contain
a recurrence rule specification.
Format Definition: This value type is defined by the following
notation:
recur = recur-rule-part *( ";" recur-rule-part )
;
; The rule parts are not ordered in any
; particular sequence.
;
; The FREQ rule part is REQUIRED,
; but MUST NOT occur more than once.
;
; The UNTIL or COUNT rule parts are OPTIONAL,
; but they MUST NOT occur in the same 'recur'.
;
; The other rule parts are OPTIONAL,
; but MUST NOT occur more than once.
recur-rule-part = ( "FREQ" "=" freq )
/ ( "UNTIL" "=" enddate )
/ ( "COUNT" "=" 1*DIGIT )
/ ( "INTERVAL" "=" 1*DIGIT )
/ ( "BYSECOND" "=" byseclist )
/ ( "BYMINUTE" "=" byminlist )
/ ( "BYHOUR" "=" byhrlist )
/ ( "BYDAY" "=" bywdaylist )
/ ( "BYMONTHDAY" "=" bymodaylist )
/ ( "BYYEARDAY" "=" byyrdaylist )
/ ( "BYWEEKNO" "=" bywknolist )
/ ( "BYMONTH" "=" bymolist )
/ ( "BYSETPOS" "=" bysplist )
/ ( "WKST" "=" weekday )
freq = "SECONDLY" / "MINUTELY" / "HOURLY" / "DAILY"
/ "WEEKLY" / "MONTHLY" / "YEARLY"
enddate = date / date-time
byseclist = ( seconds *("," seconds) )
seconds = 1*2DIGIT ;0 to 60
byminlist = ( minutes *("," minutes) )
minutes = 1*2DIGIT ;0 to 59
byhrlist = ( hour *("," hour) )
hour = 1*2DIGIT ;0 to 23
bywdaylist = ( weekdaynum *("," weekdaynum) )
weekdaynum = [[plus / minus] ordwk] weekday
plus = "+"
minus = "-"
ordwk = 1*2DIGIT ;1 to 53
weekday = "SU" / "MO" / "TU" / "WE" / "TH" / "FR" / "SA"
;Corresponding to SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY,
;FRIDAY, and SATURDAY days of the week.
bymodaylist = ( monthdaynum *("," monthdaynum) )
monthdaynum = [plus / minus] ordmoday
ordmoday = 1*2DIGIT ;1 to 31
byyrdaylist = ( yeardaynum *("," yeardaynum) )
yeardaynum = [plus / minus] ordyrday
ordyrday = 1*3DIGIT ;1 to 366
bywknolist = ( weeknum *("," weeknum) )
weeknum = [plus / minus] ordwk
bymolist = ( monthnum *("," monthnum) )
monthnum = 1*2DIGIT ;1 to 12
bysplist = ( setposday *("," setposday) )
setposday = yeardaynum
| Modifier and Type | Class and Description |
|---|---|
| public static class | |
| private class | |
| public static enum | |
| public static enum |
| Modifier and Type | Field and Description |
|---|---|
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private TemporalUnit | |
| private static final Comparator | |
| private static final String | |
| private Integer | |
| public static final String | |
| private final List | |
| private final Map | |
| private static final String | |
| private Frequency | |
| private List | |
| public static final String | |
| private static final String | |
| private Integer | |
| public static final String | KEY_MAX_INCREMENT_COUNT
When calculating dates matching this recur ( |
| private transient Logger | |
| private static final int | |
| private List | |
| public static final String | |
| private List | |
| private List | |
| public static final String | |
| private static final String | |
| private Recur. | |
| private List | |
| public static final String | |
| private static final long | |
| private List | |
| private static final String | |
| private Recur. | |
| private static final String | |
| private TemporalAdapter | |
| public static final String | |
| private List | |
| private WeekDay | |
| private static final String | |
| private List | |
| public static final String |
| Access | Constructor and Description |
|---|---|
| private | |
| public | |
| public | |
| public | |
| public | |
| public | |
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| private Frequency | |
| public boolean | equals(Object
the reference object with which to compare. o)Overrides java. Indicates whether some other object is "equal to" this one. |
| private List | Returns: a List of Temporal of the same type as the seed datethe seed date date)Returns a list of possible dates generated from the applicable BY* rules, using the specified date as a seed. |
| public final int | |
| public final List | Returns: a list of datesthe start of the period periodStart, final T the end of the period periodEnd)Returns a list of start dates in the specified period represented by this recur. |
| public final List | |
| public final List | Returns: a list of dates represented by this recur instancethe start date of this Recurrence's first instance seed, final Temporal the start of the period periodStart, final Temporal the end of the period periodEnd)Returns a list of start dates in the specified period represented by this recur. |
| public final List | Returns: a list of dates represented by this recur instancethe start date of this Recurrence's first instance seed, final Temporal the start of the period periodStart, final Temporal the end of the period periodEnd, final int limits the number of instances returned. Up to one years
worth extra may be returned. Less than 0 means no limit maxCount)Returns a list of start dates in the specified period represented by this recur. |
| public final Stream | |
| public final List | |
| public final Map | |
| public final Frequency | |
| public final List | |
| public final int | |
| public final List | |
| public final List | |
| public final List | |
| public final T | Returns: the next date in the recurrence series after startDatethe start date of this Recurrence's first instance seed, final T the date to start the search startDate)Returns the next date of this recurrence given a seed date and start date. |
| public final List | |
| public final List | |
| public Recur. | |
| public final T | |
| public final List | |
| public final WeekDay | |
| public final List | |
| public int | |
| private T | |
| private String | |
| private void | |
| public final void | setCount(final int
The count to set. count)
Deprecated
will be removed in a future version to support immutable pattern.
|
| public final void | setFrequency(final String
The frequency to set. frequency)
Deprecated
will be removed in a future version to support immutable pattern.
|
| public final void | setInterval(final int
The interval to set. interval)
Deprecated
will be removed in a future version to support immutable pattern.
|
| public final void | setUntil(final T
The until to set. until)
Deprecated
will be removed in a future version to support immutable pattern.
|
| public final void | setWeekStartDay(final WeekDay
The weekStartDay to set. weekStartDay)
Deprecated
will be removed in a future version to support immutable pattern.
|
| public final String | |
| private void | |
| private static TemporalUnit |