biweekly.util.com.google.ical.iter

Class RecurrenceIteratorFactory

java.lang.Object

biweekly.util.com.google.ical.iter.RecurrenceIteratorFactory

public class RecurrenceIteratorFactory
extends Object

Calculates the occurrences of an individual RRULE definition or groups of RRULEs, RDATEs, EXRULEs, and EXDATEs.

Glossary

• Period - year|month|day|...
• Day of the week - an int in [0,6]
• Day of the year - zero indexed in [0,365]
• Day of the month - 1 indexed in [1,31]
• Month - 1 indexed integer in [1,12]

Abstractions

• Generator - a function corresponding to an RRULE part that takes a date and returns a later (year or month or day depending on its period) within the next larger period. A generator ignores all periods in its input smaller than its period.
• Filter - a function that returns true iff the given date matches the subrule.
• Condition - returns true if the given date is past the end of the recurrence.

All the functions that represent rule parts are stateful.

Author:

mikesamuel+svn@gmail.com (Mike Samuel), Michael Angstadt

Method Summary

Methods

Modifier and Type	Method and Description
static RecurrenceIterable	createRecurrenceIterable(Recurrence rrule, DateValue dtStart, TimeZone tzid) Creates a recurrence iterable from an RRULE.
static RecurrenceIterator	createRecurrenceIterator(Collection<? extends DateValue> dates) Creates a recurrence iterator from an RDATE or EXDATE list.
static RecurrenceIterator	createRecurrenceIterator(Recurrence rrule, DateValue dtStart, TimeZone tzid) Creates a recurrence iterator from an RRULE.
static RecurrenceIterator	except(RecurrenceIterator included, RecurrenceIterator excluded) Generates a recurrence iterator that iterates over all the dates in a RecurrenceIterator, excluding those dates found in another RecurrenceIterator.
static RecurrenceIterator	join(RecurrenceIterator first, RecurrenceIterator... rest) Generates a recurrence iterator that iterates over the union of the given recurrence iterators.

Methods inherited from class java.lang.Object

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

Method Detail

createRecurrenceIterator

public static RecurrenceIterator createRecurrenceIterator(Collection<? extends DateValue> dates)

Creates a recurrence iterator from an RDATE or EXDATE list.

Parameters:

dates - the list of dates

Returns:

the iterator

createRecurrenceIterable

public static RecurrenceIterable createRecurrenceIterable(Recurrence rrule,
                                          DateValue dtStart,
                                          TimeZone tzid)

Creates a recurrence iterable from an RRULE.

Parameters:

rrule - the recurrence rule

dtStart - the start date of the series

tzid - the timezone that the start date is in, as well as the timezone to iterate in

Returns:

the iterable

createRecurrenceIterator

public static RecurrenceIterator createRecurrenceIterator(Recurrence rrule,
                                          DateValue dtStart,
                                          TimeZone tzid)

Creates a recurrence iterator from an RRULE.

Parameters:

rrule - the recurrence rule

dtStart - the start date of the series

tzid - the timezone that the start date is in, as well as the timezone to iterate in

Returns:

the iterator

join

public static RecurrenceIterator join(RecurrenceIterator first,
                      RecurrenceIterator... rest)

Generates a recurrence iterator that iterates over the union of the given recurrence iterators.

Parameters:

first - the first recurrence iterator

rest - the other recurrence iterators

Returns:

the union iterator

except

public static RecurrenceIterator except(RecurrenceIterator included,
                        RecurrenceIterator excluded)

Generates a recurrence iterator that iterates over all the dates in a RecurrenceIterator, excluding those dates found in another RecurrenceIterator.

Exclusions trump inclusions, and dates and date-times never match one another.

Parameters:

included - the dates to include

excluded - the dates to exclude

Returns:

the resultant iterator