biweekly.property

Class RecurrenceId

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<ICalDate>

biweekly.property.DateOrDateTimeProperty

biweekly.property.RecurrenceId

public class RecurrenceId
extends DateOrDateTimeProperty

Records the original value of the DateStart property if a recurrence instance has been modified. It is used in conjunction with the Uid and Sequence properties to uniquely identify a recurrence instance.

Code sample:

 VEvent event = new VEvent();
 
 //date-time value
 Date datetime = ...
 RecurrenceId recurrenceId = new RecurrenceId(datetime);
 event.setRecurrenceId(recurrenceId);
 
 //date value
 Date date = ...
 RecurrenceId recurrenceId = new RecurrenceId(date, false);
 event.setRecurrenceId(recurrenceId);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.112-4, RFC 2445 p.107-9

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
RecurrenceId(Date originalStartDate) Creates a recurrence ID property.
RecurrenceId(Date originalStartDate, boolean hasTime) Creates a recurrence ID property.
RecurrenceId(ICalDate originalStartDate) Creates a recurrence ID property.

Method Summary

Methods

Modifier and Type	Method and Description
Range	getRange() Gets the effective range of recurrence instances from the instance specified by this property.
void	setRange(Range range) Sets the effective range of recurrence instances from the instance specified by this property.

Methods inherited from class biweekly.property.DateOrDateTimeProperty

setValue

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecurrenceId

public RecurrenceId(ICalDate originalStartDate)

Creates a recurrence ID property.

Parameters:

originalStartDate - the original start date

RecurrenceId

public RecurrenceId(Date originalStartDate)

Creates a recurrence ID property.

Parameters:

originalStartDate - the original start date

RecurrenceId

public RecurrenceId(Date originalStartDate,
            boolean hasTime)

Creates a recurrence ID property.

Parameters:

originalStartDate - the original start date

hasTime - true to include the time component of the date, false not to

Method Detail

getRange

public Range getRange()

Gets the effective range of recurrence instances from the instance specified by this property.

Returns:

the range or null if not set

See Also:

RFC 5545 p.23-4

setRange

public void setRange(Range range)

Sets the effective range of recurrence instances from the instance specified by this property.

Parameters:

range - the range or null to remove

See Also:

RFC 5545 p.23-4