org.dmfs.rfc5545.recur

Class FastBirthdayIterator

java.lang.Object

org.dmfs.rfc5545.recur.FastBirthdayIterator

public final class FastBirthdayIterator
extends java.lang.Object

Fast path for birthday type rules (i.e. instances that recur once a year on the same day and month).

Be sure to add a SanityFilter right after this to filter invalid dates like Feb 29th in non-leap years and to inject the start date if it's not synchronized with the rule. Also you'll have to add a CountLimiter or UntilLimiter if needed.

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 FastBirthdayIterator	getInstance(RecurrenceRule rule, org.dmfs.rfc5545.calendarmetrics.CalendarMetrics calendarMetrics, long start) Get an instance of a FastBirthdayIterator 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 FastBirthdayIterator getInstance(RecurrenceRule rule,
                                               org.dmfs.rfc5545.calendarmetrics.CalendarMetrics calendarMetrics,
                                               long start)

Get an instance of a FastBirthdayIterator 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.