Class RDate

  • All Implemented Interfaces:

    public class RDate
    extends DateListProperty

    Created: [Apr 6, 2004]

    Defines an RDATE iCalendar component property.
 Recurrence Date/Times
            Property Name: RDATE
            Purpose: This property defines the list of date/times for a
            recurrence set.
            Value Type: The default value type for this property is DATE-TIME.
            The value type can be set to DATE or PERIOD.
            Property Parameters: Non-standard, value data type and time zone
            identifier property parameters can be specified on this property.
            Conformance: The property can be specified in "VEVENT", "VTODO",
            "VJOURNAL" or "VTIMEZONE" calendar components.
            Description: This property can appear along with the "RRULE" property
            to define an aggregate set of repeating occurrences. When they both
            appear in an iCalendar object, the recurring events are defined by
            the union of occurrences defined by both the "RDATE" and "RRULE".
            The recurrence dates, if specified, are used in computing the
            recurrence set. The recurrence set is the complete set of recurrence
            instances for a calendar component. The recurrence set is generated
            by considering the initial "DTSTART" property along with the "RRULE",
            "RDATE", "EXDATE" and "EXRULE" properties contained within the
            iCalendar object. The "DTSTART" property defines the first instance
            in the recurrence set. Multiple instances of the "RRULE" and "EXRULE"
            properties can also be specified to define more sophisticated
            recurrence sets. The final recurrence set is generated by gathering
            all of the start date/times generated by any of the specified "RRULE"
            and "RDATE" properties, and excluding any start date/times which fall
            within the union of start date/times generated by any specified
            "EXRULE" and "EXDATE" properties. This implies that start date/times
            within exclusion related properties (i.e., "EXDATE" and "EXRULE")
            take precedence over those specified by inclusion properties (i.e.,
            "RDATE" and "RRULE"). Where duplicate instances are generated by the
            "RRULE" and "RDATE" properties, only one recurrence is considered.
            Duplicate instances are ignored.
            Format Definition: The property is defined by the following notation:
              rdate      = "RDATE" rdtparam ":" rdtval *("," rdtval) CRLF
              rdtparam   = *(
                         ; the following are optional,
                         ; but MUST NOT occur more than once
                         (";" "VALUE" "=" ("DATE-TIME"
                          / "DATE" / "PERIOD")) /
                         (";" tzidparam) /
                         ; the following is optional,
                         ; and MAY occur more than once
                         (";" xparam)
              rdtval     = date-time / date / period
              ;Value MUST match value type
            Example: The following are examples of this property:
    See Also:
    Serialized Form
    • Constructor Detail

      • RDate

        public RDate()
        Default constructor.
      • RDate

        public RDate​(ParameterList aList,
                     String aValue)
              throws ParseException
        aList - a list of parameters for this component
        aValue - a value string for this component
        ParseException - where the specified value string is not a valid date-time/date representation
      • RDate

        public RDate​(DateList dates)
        Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
        dates - a list of dates
      • RDate

        public RDate​(ParameterList aList,
                     DateList dates)
        Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
        aList - a list of parameters for this component
        dates - a list of dates
      • RDate

        public RDate​(PeriodList periods)
        periods - a list of periods
      • RDate

        public RDate​(ParameterList aList,
                     PeriodList periods)
        aList - a list of parameters for this component
        periods - a list of periods
    • Method Detail

      • getPeriods

        public final PeriodList getPeriods()
        Returns the period list.
      • setValue

        public final void setValue​(String aValue)
                            throws ParseException
        Sets the current value of the property.
        setValue in class DateListProperty
        aValue - a string representation of the property value
        ParseException - possibly thrown by setting the value of certain properties
      • setTimeZone

        public final void setTimeZone​(TimeZone timezone)
        Sets the timezone associated with this property.
        setTimeZone in class DateListProperty
        timezone - a timezone to associate with this property