Class RecurrenceId<T extends Temporal>
- java.lang.Object
-
- net.fortuna.ical4j.model.Content
-
- net.fortuna.ical4j.model.Property
-
- net.fortuna.ical4j.model.property.DateProperty<T>
-
- net.fortuna.ical4j.model.property.RecurrenceId<T>
-
- All Implemented Interfaces:
Serializable
,Comparable<Property>
,FluentProperty
public class RecurrenceId<T extends Temporal> extends DateProperty<T>
$Id$ Created: [Apr 6, 2004] Defines a RECURRENCE-ID iCalendar component property.4.8.4.4 Recurrence ID Property Name: RECURRENCE-ID Purpose: This property is used in conjunction with the "UID" and "SEQUENCE" property to identify a specific instance of a recurring "VEVENT", "VTODO" or "VJOURNAL" calendar component. The property value is the effective value of the "DTSTART" property of the recurrence instance. Value Type: The default value type for this property is DATE-TIME. The time format can be any of the valid forms defined for a DATE-TIME value type. See DATE-TIME value type definition for specific interpretations of the various forms. The value type can be set to DATE. Property Parameters: Non-standard property, value data type, time zone identifier and recurrence identifier range parameters can be specified on this property. Conformance: This property can be specified in an iCalendar object containing a recurring calendar component. Description: The full range of calendar components specified by a recurrence set is referenced by referring to just the "UID" property value corresponding to the calendar component. The "RECURRENCE-ID" property allows the reference to an individual instance within the recurrence set. If the value of the "DTSTART" property is a DATE type value, then the value MUST be the calendar date for the recurrence instance. The date/time value is set to the time when the original recurrence instance would occur; meaning that if the intent is to change a Friday meeting to Thursday, the date/time is still set to the original Friday meeting. The "RECURRENCE-ID" property is used in conjunction with the "UID" and "SEQUENCE" property to identify a particular instance of a recurring event, to-do or journal. For a given pair of "UID" and "SEQUENCE" property values, the "RECURRENCE-ID" value for a recurrence instance is fixed. When the definition of the recurrence set for a calendar component changes, and hence the "SEQUENCE" property value changes, the "RECURRENCE-ID" for a given recurrence instance might also change.The "RANGE" parameter is used to specify the effective range of recurrence instances from the instance specified by the "RECURRENCE-ID" property value. The default value for the range parameter is the single recurrence instance only. The value can also be "THISANDPRIOR" to indicate a range defined by the given recurrence instance and all prior instances or the value can be "THISANDFUTURE" to indicate a range defined by the given recurrence instance and all subsequent instances. Format Definition: The property is defined by the following notation: recurid = "RECURRENCE-ID" ridparam ":" ridval CRLF ridparam = *( ; the following are optional, ; but MUST NOT occur more than once (";" "VALUE" "=" ("DATE-TIME" / "DATE)) / (";" tzidparam) / (";" rangeparam) / ; the following is optional, ; and MAY occur more than once (";" xparam) ) ridval = date-time / date ;Value MUST match value type
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RecurrenceId.Factory<T extends Temporal>
-
Field Summary
-
Fields inherited from class net.fortuna.ical4j.model.Property
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION
-
-
Constructor Summary
Constructors Constructor Description RecurrenceId()
RecurrenceId(String value)
Creates a new instance initialised with the parsed value.RecurrenceId(ParameterList aList, String aValue)
RecurrenceId(ParameterList aList, T aDate)
Constructor.RecurrenceId(T aDate)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected PropertyFactory<RecurrenceId<T>>
newFactory()
Returns a new property factory used to create deep copies.ValidationResult
validate()
Perform validation on a property.-
Methods inherited from class net.fortuna.ical4j.model.property.DateProperty
compareTo, getDate, getValue, hashCode, isUtc, setDate, setTimeZoneRegistry, setValue
-
Methods inherited from class net.fortuna.ical4j.model.Property
add, copy, equals, getFluentTarget, getName, getParameter, getParameterList, getParameters, getRequiredParameter, remove, removeAll, replace, setParameters, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.fortuna.ical4j.model.FluentProperty
withParameter
-
-
-
-
Constructor Detail
-
RecurrenceId
public RecurrenceId()
-
RecurrenceId
public RecurrenceId(String value)
Creates a new instance initialised with the parsed value.- Parameters:
value
- the RECURRENCE_ID value string to parse
-
RecurrenceId
public RecurrenceId(ParameterList aList, String aValue)
- Parameters:
aList
- a list of parameters for this componentaValue
- a value string for this component
-
RecurrenceId
public RecurrenceId(T aDate)
Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.- Parameters:
aDate
- a date representation of a date or date-time
-
RecurrenceId
public RecurrenceId(ParameterList aList, T aDate)
Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.- Parameters:
aList
- a list of parameters for this componentaDate
- a date representation of a date or date-time
-
-
Method Detail
-
validate
public ValidationResult validate() throws ValidationException
Perform validation on a property.- Overrides:
validate
in classDateProperty<T extends Temporal>
- Throws:
ValidationException
- where the property is not in a valid state
-
newFactory
protected PropertyFactory<RecurrenceId<T>> newFactory()
Description copied from class:Property
Returns a new property factory used to create deep copies.- Specified by:
newFactory
in classProperty
- Returns:
- a property factory instance
-
-