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.getDates().add(new ICalDate(datetime, true));
 event.addRecurrenceDates(rdate);
 
 //date values
 Date date = ...
 RecurrenceDates rdate = new RecurrenceDates();
 rdate.getDates().add(new ICalDate(date, false));
 event.addRecurrenceDates(rdate);
 
 //periods
 Period period = ...
 rdate = new RecurrenceDates();
 rdate.getPeriods().add(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()
RecurrenceDates(RecurrenceDates original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
RecurrenceDates	copy() Creates a copy of this property object.
boolean	equals(Object obj)
List<ICalDate>	getDates() Gets the list that stores this property's recurrence dates.
List<Period>	getPeriods() Gets the list that stores this property's time periods.
int	hashCode()
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurrenceDates

public RecurrenceDates()

RecurrenceDates

public RecurrenceDates(RecurrenceDates original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getDates

public List<ICalDate> getDates()

Gets the list that stores this property's recurrence dates.

Returns:

the dates (this list is mutable)

getPeriods

public List<Period> getPeriods()

Gets the list that stores this property's time periods.

Returns:

the time periods (this list is mutable)

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 specifications.

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

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalProperty

Gets string representations of the class's fields for the ICalProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class ICalProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

public RecurrenceDates copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy

hashCode

public int hashCode()

Overrides:

hashCode in class ICalProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalProperty