Class RecurrenceId

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.VParentBase<RecurrenceId>

jfxtras.icalendarfx.properties.VPropertyBase<Temporal, RecurrenceId>

jfxtras.icalendarfx.properties.PropBaseDateTime<Temporal, RecurrenceId>

jfxtras.icalendarfx.properties.component.relationship.RecurrenceId

All Implemented Interfaces:

PropDateTime<Temporal>, PropRecurrenceID<Temporal>, VProperty<Temporal>, VChild, VElement, VParent

public class RecurrenceId
extends PropBaseDateTime<Temporal, RecurrenceId>
implements PropRecurrenceID<Temporal>

RECURRENCE-ID RFC 5545, 3.8.4.4, page 112 This property is used in conjunction with the "UID" and "SEQUENCE" properties to identify a specific instance of a recurring "VEVENT", "VTODO", or "VJOURNAL" calendar component. The property value is the original value of the "DTSTART" property of the recurrence instance. The "RANGE" parameter is used to specify the effective range of recurrence instances from the instance specified by the "RECURRENCE-ID" property value. The value for the range parameter can only be "THISANDFUTURE" Note: THISANDFUTURE is not supported by most iCalendar implementations. It may be better to truncate the unbounded recurring calendar component (i.e., with the "COUNT" or "UNTIL" rule parts), and create two new unbounded recurring calendar components for the future instances. Example: RECURRENCE-ID;VALUE=DATE:19960401

See Also:

• VEvent
• VTodo
• VJournal

Nested Class Summary

Nested classes/interfaces inherited from class VElementBase

VElementBase.Message, VElementBase.MessageEffect

Field Summary

Fields

Modifier and Type	Field	Description
private Range	range

Fields inherited from class VPropertyBase

actualValueContent, allowedValueTypes, defaultValueType, propertyName

Fields inherited from class VParentBase

contentLineGenerator, orderer

Fields inherited from class VElementBase

BEGIN, END

Constructor Summary

Constructors

Constructor	Description
RecurrenceId()
RecurrenceId(Temporal temporal)
RecurrenceId(RecurrenceId source)

Method Summary

Modifier and Type	Method	Description
Range	getRange()	RANGE Recurrence Identifier Range RFC 5545, 3.2.13, page 23 To specify the effective range of recurrence instances from the instance specified by the recurrence identifier specified by the property.
static RecurrenceId	parse(Class<? extends Temporal> clazz, String content)	Parse string with Temporal class explicitly provided as parameter
static RecurrenceId	parse(String content)	Parse string to Temporal.
void	setRange(String value)
void	setRange(Range range)
RecurrenceId	withRange(String content)
RecurrenceId	withRange(Range altrep)
RecurrenceId	withRange(Range.RangeType value)

Methods inherited from class PropBaseDateTime

errors, getTimeZoneIdentifier, modifiedValue, setTimeZoneIdentifier, setTimeZoneIdentifier, setTimeZoneIdentifier, setValue, withTimeZoneIdentifier, withTimeZoneIdentifier, withTimeZoneIdentifier

Methods inherited from class VPropertyBase

copyValue, equals, getConverter, getNonStandard, getParent, getUnknownValue, getValue, getValueType, hashCode, name, parseContent, processInLineChild, setConverter, setConverterByClass, setNonStandard, setParent, setValueType, setValueType, toString, valueContent, withNonStandard, withNonStandard, withNonStandard, withValue, withValueType

Methods inherited from class VParentBase

addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, removeChild, removeChild, replaceChild, replaceChild, withChild

Methods inherited from class VElementBase

elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface VChild

getParent, setParent

Methods inherited from interface VElement

errors, isValid, name

Methods inherited from interface VParent

addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface VProperty

getNonStandard, getValue, getValueType, setNonStandard, setValue, setValueType

Field Details

range

private Range range

Constructor Details

RecurrenceId

public RecurrenceId(Temporal temporal)

RecurrenceId

public RecurrenceId(RecurrenceId source)

RecurrenceId

public RecurrenceId()

Method Details

getRange

public Range getRange()

RANGE Recurrence Identifier Range RFC 5545, 3.2.13, page 23 To specify the effective range of recurrence instances from the instance specified by the recurrence identifier specified by the property. Example: RECURRENCE-ID;RANGE=THISANDFUTURE:19980401T133000Z

Specified by:

getRange in interface PropRecurrenceID<Temporal>

setRange

public void setRange(Range range)

Specified by:

setRange in interface PropRecurrenceID<Temporal>

setRange

public void setRange(String value)

withRange

public RecurrenceId withRange(Range altrep)

withRange

public RecurrenceId withRange(Range.RangeType value)

withRange

public RecurrenceId withRange(String content)

parse

public static RecurrenceId parse(String content)

Parse string to Temporal. Not type safe. Implementation must ensure parameterized type is the same as date-time represented by String parameter

parse

public static RecurrenceId parse(Class<? extends Temporal> clazz,
 String content)

Parse string with Temporal class explicitly provided as parameter