biweekly.property

Class RecurrenceDates

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.RecurrenceDates

public class RecurrenceDates
extends ICalProperty

Defines a list of dates or time periods that help define a recurrence rule. It must contain either dates or time periods. It cannot contain a combination of both.

Code sample:

 VEvent event = new VEvent();
 
 //date-time values
 Date datetime = ...
 RecurrenceDates rdate = new RecurrenceDates();
 rdate.addDate(new ICalDate(datetime, true));
 event.addRecurrenceDates(rdate);
 
 //date values
 Date date = ...
 RecurrenceDates rdate = new RecurrenceDates();
 rdate.addDate(new ICalDate(date, false));
 event.addRecurrenceDates(rdate);
 
 //periods
 Period period = ...
 rdate = new RecurrenceDates();
 rdate.addPeriod(period);
 event.addRecurrenceDates(rdate);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.120-2, RFC 2445 p.115-7, vCal 1.0 p.34

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
RecurrenceDates()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDate(Date date) Adds a date
void	addDate(ICalDate date) Adds a date.
void	addPeriod(Period period) Adds a period
List<ICalDate>	getDates() Gets the recurrence dates.
List<Period>	getPeriods() Gets the time periods.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

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

RecurrenceDates

public RecurrenceDates()

Method Detail

getDates

public List<ICalDate> getDates()

Gets the recurrence dates.

Returns:

the dates

addDate

public void addDate(ICalDate date)

Adds a date.

Parameters:

date - the date to add

addDate

public void addDate(Date date)

Adds a date

Parameters:

date - the date to add

getPeriods

public List<Period> getPeriods()

Gets the time periods.

Returns:

the time periods

addPeriod

public void addPeriod(Period period)

Adds a period

Parameters:

period - the period to add

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to