Package org.dmfs.rfc5545.recur
Enum Class RecurrenceRule.Part
- All Implemented Interfaces:
Serializable,Comparable<RecurrenceRule.Part>,Constable
- Enclosing class:
- RecurrenceRule
Enumeration of valid recurrence rule parts. Each of these parts may occur once in a rule.
FREQ is the only mandatory part. Each part has a
RecurrenceRule.ValueConverter that knows how to parse and serialize the values the part can have. Also each part has a factory method to return a RuleIterator for this part. FREQ, INTERVAL, WKST and RSCALE don't support iteration nor expansion and will throw an
UnsupportedOperationException when calling getExpander(RecurrenceRule, RuleIterator, CalendarMetrics, long, TimeZone) or PartgetFilter(RecurrenceRule, CalendarMetrics).
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA special BYDAY filter for expander rewritingA special BYMONTH filter for expander rewritingA special BYMONTHDAY filter for expander rewritingThe SKIP filter for monthdays.The SKIP filter for months.A special BYWEEKNO filter for expander rewritingA special BYYEARDAY filter for expander rewritingFilters all invalid dates.A list ofRecurrenceRule.WeekdayNums on which the event recurs.The hours on which the event recurs.The minutes on which the event recurs.A list of months that specify in which months the instances recur.A list of month days on which the event recurs.The seconds on which the event recurs.A list of set positions to consider when iterating the instances.A list of week numbers that specify in which weeks the instances recur.A list of year days that specify on which year days the instances recur.This part specifies total number of instances.Base frequency of the recurring instances.The base interval of the recurring instances.RSCALE defines the calendar scale to apply.SKIP defines how to handle instances that would fall on a leap day or leap month in a non-leap year.This part specifies the latest date of the last instance.The start day of a week. -
Method Summary
Modifier and TypeMethodDescriptionstatic RecurrenceRule.PartReturns the enum constant of this class with the specified name.static RecurrenceRule.Part[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FREQ
Base frequency of the recurring instances. This value is mandatory in every recurrence rule. The value must be aFreq. -
INTERVAL
The base interval of the recurring instances. If not specified the interval is1. The value must be a positive integer. -
RSCALE
RSCALE defines the calendar scale to apply. It has been introduced in http://tools.ietf.org/html/draft-daboo-icalendar-rscale-03 -
WKST
-
BYMONTH
A list of months that specify in which months the instances recur. The value is a list of non-zero integers. The actual values depend on the calendar scale and need to be validated after parsing.TODO: validate month numbers.
-
_BYMONTHSKIP
The SKIP filter for months. This must not appear in an RRULE, any attempt to parse a value will fail. This is just an implementation helper. -
BYWEEKNO
A list of week numbers that specify in which weeks the instances recur.TODO: validate week numbers
-
BYYEARDAY
A list of year days that specify on which year days the instances recur. The actual limits depend on the calendar scale and needs to be validated after parsing. Negative values are supported only ifRSCALEis present.TODO: validate year days
-
BYMONTHDAY
A list of month days on which the event recurs. Valid values are non-zero integers. The actual limits depend on the calendar scale and needs to be validated after parsing.TODO: validate month days
-
_BYMONTHDAYSKIP
The SKIP filter for monthdays. This must not appear in an RRULE, any attempt to parse a value will fail. This is just an implementation helper. -
BYDAY
A list ofRecurrenceRule.WeekdayNums on which the event recurs. -
_BYMONTH_FILTER
A special BYMONTH filter for expander rewriting -
_BYWEEKNO_FILTER
A special BYWEEKNO filter for expander rewriting -
_BYYEARDAY_FILTER
A special BYYEARDAY filter for expander rewriting -
_BYMONTHDAY_FILTER
A special BYMONTHDAY filter for expander rewriting -
_BYDAY_FILTER
A special BYDAY filter for expander rewriting -
BYHOUR
The hours on which the event recurs. The value must be a list of integers in the range 0 to 23. -
BYMINUTE
The minutes on which the event recurs. The value must be a list of integers in the range 0 to 59. -
BYSECOND
The seconds on which the event recurs. The value must be a list of integers in the range 0 to 60. -
SKIP
SKIP defines how to handle instances that would fall on a leap day or leap month in a non-leap year. Legal values are defined inRecurrenceRule.Skip. It has been introduced by http://tools.ietf.org/html/draft-daboo-icalendar-rscale-03Skipping is implemented by an expander because it might modify instances which is not supported by filters.
-
_SANITY_FILTER
Filters all invalid dates. This must not appear in an RRULE, any attempt to parse a value will fail. This is just an implementation helper. -
BYSETPOS
A list of set positions to consider when iterating the instances. The value is a list of integers. For now we accept any reasonable value.TODO: validate the values. They should be within the limits of byyearday.
-
UNTIL
-
COUNT
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-