Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class RDate<T extends Temporal>

extends DateListProperty<T extends Temporal>
Class Inheritance
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.parameter.Value, net.fortuna.ical4j.util.Strings, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.RecurrencePropertyValidators, java.time.temporal.Temporal, java.util.List, .Optional, .Set
$Id$

Created: [Apr 6, 2004]

Defines an RDATE iCalendar component property. 

    4.8.5.3 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:

         RDATE:19970714T123000Z

         RDATE;TZID=US-EASTERN:19970714T083000

         RDATE;VALUE=PERIOD:19960403T020000Z/19960403T040000Z,
          19960404T010000Z/PT3H

         RDATE;VALUE=DATE:19970101,19970120,19970217,19970421
          19970526,19970704,19970901,19971014,19971128,19971129,19971225
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RDate.Factory<T extends Temporal>

Field Summary

Modifier and TypeField and Description
private PeriodList<T>
periods

private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.property.DateListProperty.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
RDate()

Default constructor.

public
RDate(final ParameterList
a list of parameters for this component
aList, final String
a value string for this component
aValue)

public
RDate(final DateList<T>
a list of dates
dates)

Constructor.

public
RDate(final ParameterList
a list of parameters for this component
aList, final DateList<T>
a list of dates
dates)

Constructor.

public
RDate(final List<Period<T>>
a list of periods
periods)

Constructor.

public
RDate(final ParameterList
a list of parameters for this component
aList, final List<Period<T>>
a list of periods
periods)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public final Optional<Set<Period<T>>>

Returns:

Returns the period list.
getPeriods()

public final String
getValue()

Overrides net.fortuna.ical4j.model.property.DateListProperty.getValue.

protected PropertyFactory<RDate<T>>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue)

Overrides net.fortuna.ical4j.model.property.DateListProperty.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.property.DateListProperty:
getDatessetDefaultTimeZonesetTimeZoneRegistry

Field Detail

periodsback to summary
private PeriodList<T> periods
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.property.DateListProperty.serialVersionUID.

Constructor Detail

RDateback to summary
public RDate()

Default constructor.

RDateback to summary
public RDate(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

RDateback to summary
public RDate(final DateList<T> dates)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters
dates:DateList<T>

a list of dates

RDateback to summary
public RDate(final ParameterList aList, final DateList<T> dates)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters
aList:ParameterList

a list of parameters for this component

dates:DateList<T>

a list of dates

RDateback to summary
public RDate(final List<Period<T>> periods)

Constructor.

Parameters
periods:List<Period<T>>

a list of periods

RDateback to summary
public RDate(final ParameterList aList, final List<Period<T>> periods)

Constructor.

Parameters
aList:ParameterList

a list of parameters for this component

periods:List<Period<T>>

a list of periods

Method Detail

getPeriodsback to summary
public final Optional<Set<Period<T>>> getPeriods()
Returns:Optional<Set<Period<T>>>

Returns the period list.

getValueback to summary
public final String getValue()

Overrides net.fortuna.ical4j.model.property.DateListProperty.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<RDate<T>> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<RDate<T>>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Overrides net.fortuna.ical4j.model.property.DateListProperty.setValue.

Doc from net.fortuna.ical4j.model.property.DateListProperty.setValue.

Sets the current value of the property.

Parameters
aValue:String

Doc from net.fortuna.ical4j.model.Property.setValue.

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class RDate.Factory<T extends Temporal>

extends Factory
implements PropertyFactory<RDate<T extends Temporal>>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public RDate<T>
createProperty(final ParameterList
a list of property parameters
parameters, final String
a property value
value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public RDate<T>
createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public RDate<T> createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:RDate<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public RDate<T> createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:RDate<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override