com.google.ical.iter

Class RecurrenceIteratorFactory

java.lang.Object

com.google.ical.iter.RecurrenceIteratorFactory

public class RecurrenceIteratorFactory
extends java.lang.Object

for calculating the occurrences of an individual RFC 2445 RRULE or groups of RRULES, RDATES, EXRULES, and EXDATES.

Glossary

Period - year|month|day|...
Day of the week - an int in [0-6]. See RRULE_WDAY_* in rrule.js
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.

Method Summary

Modifier and Type	Method and Description
static RecurrenceIterable	createRecurrenceIterable(java.lang.String rdata, DateValue dtStart, java.util.TimeZone tzid, boolean strict)
static RecurrenceIterator	createRecurrenceIterator(RDateList rdates) create a recurrence iterator from an rdate or exdate list.
static RecurrenceIterator	createRecurrenceIterator(RRule rrule, DateValue dtStart, java.util.TimeZone tzid) create a recurrence iterator from an rrule.
static RecurrenceIterator	createRecurrenceIterator(java.lang.String rdata, DateValue dtStart, java.util.TimeZone tzid) like createRecurrenceIterator(String,DateValue,TimeZone,boolean) but defaults to strict parsing.
static RecurrenceIterator	createRecurrenceIterator(java.lang.String rdata, DateValue dtStart, java.util.TimeZone tzid, boolean strict) given a block of RRULE, EXRULE, RDATE, and EXDATE content lines, parse them into a single recurrence iterator.
static RecurrenceIterator	except(RecurrenceIterator included, RecurrenceIterator excluded) an iterator over all the dates included except those excluded, i.e.
static RecurrenceIterator	join(RecurrenceIterator a, RecurrenceIterator... b) a recurrence iterator that returns 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(java.lang.String rdata,
                                                          DateValue dtStart,
                                                          java.util.TimeZone tzid,
                                                          boolean strict)
                                                   throws java.text.ParseException

given a block of RRULE, EXRULE, RDATE, and EXDATE content lines, parse them into a single recurrence iterator.

Parameters:

rdata - ical text.

dtStart - the date of the first occurrence in timezone tzid, which is used to fill in optional fields in the RRULE, such as the day of the month for a monthly repetition when no ther day specified. Note: this may not be the first date in the series since an EXRULE or EXDATE might force it to be skipped, but there will be no earlier date generated by this ruleset.

strict - true if any failure to parse should result in a ParseException. false causes bad content lines to be logged and ignored.

Throws:

java.text.ParseException

createRecurrenceIterable

public static RecurrenceIterable createRecurrenceIterable(java.lang.String rdata,
                                                          DateValue dtStart,
                                                          java.util.TimeZone tzid,
                                                          boolean strict)
                                                   throws java.text.ParseException

Throws:

java.text.ParseException

createRecurrenceIterator

public static RecurrenceIterator createRecurrenceIterator(java.lang.String rdata,
                                                          DateValue dtStart,
                                                          java.util.TimeZone tzid)
                                                   throws java.text.ParseException

like createRecurrenceIterator(String,DateValue,TimeZone,boolean) but defaults to strict parsing.

Throws:

java.text.ParseException

createRecurrenceIterator

public static RecurrenceIterator createRecurrenceIterator(RDateList rdates)

create a recurrence iterator from an rdate or exdate list.

createRecurrenceIterator

public static RecurrenceIterator createRecurrenceIterator(RRule rrule,
                                                          DateValue dtStart,
                                                          java.util.TimeZone tzid)

create a recurrence iterator from an rrule.

Parameters:

rrule - the recurrence rule to iterate.

dtStart - the start of the series, in tzid.

tzid - the timezone to iterate in.

join

public static RecurrenceIterator join(RecurrenceIterator a,
                                      RecurrenceIterator... b)

a recurrence iterator that returns the union of the given recurrence iterators.

except

public static RecurrenceIterator except(RecurrenceIterator included,
                                        RecurrenceIterator excluded)

an iterator over all the dates included except those excluded, i.e. inclusions - exclusions. Exclusions trump inclusions, and dates and date-times never match one another.

Parameters:

included - non null.

excluded - non null.

Returns:

non null.