org.dmfs.rfc5545.recur

Class FastWeeklyIterator

java.lang.Object

org.dmfs.rfc5545.recur.FastWeeklyIterator

public final class FastWeeklyIterator
extends java.lang.Object

Fast path for once a week type rules (i.e. instances recur once a week on the same weekday). You don't need to add a SanityFilter, since this method won't iterate invalid dates and takes care of adding unsynchronized start dates.

This class also stops iterating after the right number of instances if a COUNT part is present, but you still need to add an UntilLimiter if an UNTIL part is present.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	org.dmfs.rfc5545.recur.ByExpander.Scope The scope of a part.

Method Summary

Modifier and Type	Method and Description
static FastWeeklyIterator	getInstance(RecurrenceRule rule, org.dmfs.rfc5545.calendarmetrics.CalendarMetrics calendarMetrics, long start) Get an instance of a FastWeeklyIterator for the given rule.
long	next() Get the next instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FastWeeklyIterator getInstance(RecurrenceRule rule,
                                             org.dmfs.rfc5545.calendarmetrics.CalendarMetrics calendarMetrics,
                                             long start)

Get an instance of a FastWeeklyIterator for the given rule.

Parameters:

rule - The RecurrenceRule to iterate.

calendarMetrics - The CalendarMetrics to use.

start - The first instance.

Returns:

A FastBirthdayIterator instance or null if the rule is not suitable for this kind of optimization.

next

public long next()

Get the next instance. The instances are guaranteed to be strictly increasing in time.

If the last instance has been iterated, all subsequent calls to this method will return Long.MIN_VALUE.

Returns:

An long that specifies the next instance or Long.MIN_VALUE if there are no more instances.