biweekly.property

Class RecurrenceProperty

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<Recurrence>

biweekly.property.RecurrenceProperty

Direct Known Subclasses:

ExceptionRule, RecurrenceRule

public class RecurrenceProperty
extends ValuedProperty<Recurrence>

Represents a property whose value is a recurrence rule.

Author:

Michael Angstadt

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
RecurrenceProperty(Recurrence recur) Creates a new recurrence property.
RecurrenceProperty(RecurrenceProperty original) Copy constructor.

Method Summary

Modifier and Type	Method and Description
DateIterator	getDateIterator(Date startDate, TimeZone timezone) Creates an iterator that computes the dates defined by this property.
DateIterator	getDateIterator(ICalDate startDate, TimeZone timezone) Creates an iterator that computes the dates defined by this property.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<ValidationWarning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ValuedProperty

equals, getValue, getValue, hashCode, setValue, toStringValues, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

addParameter, copy, 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

RecurrenceProperty

public RecurrenceProperty(Recurrence recur)

Creates a new recurrence property.

Parameters:

recur - the recurrence value

RecurrenceProperty

public RecurrenceProperty(RecurrenceProperty original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getDateIterator

public DateIterator getDateIterator(Date startDate,
                                    TimeZone timezone)

Creates an iterator that computes the dates defined by this property.

Parameters:

startDate - the date that the recurrence starts (typically, the value of the accompanying DateStart property)

timezone - the timezone to iterate in (typically, the timezone associated with the DateStart property). This is needed in order to adjust for when the iterator passes over a daylight savings boundary.

Returns:

the iterator

See Also:

google-rfc-2445

getDateIterator

public DateIterator getDateIterator(ICalDate startDate,
                                    TimeZone timezone)

Creates an iterator that computes the dates defined by this property.

Parameters:

startDate - the date that the recurrence starts (typically, the value of the accompanying DateStart property)

timezone - the timezone to iterate in (typically, the timezone associated with the DateStart property). This is needed in order to adjust for when the iterator passes over a daylight savings boundary.

Returns:

the iterator

See Also:

google-rfc-2445

validate

protected void validate(List<ICalComponent> components,
                        ICalVersion version,
                        List<ValidationWarning> 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 ValuedProperty<Recurrence>

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