org.dmfs.rfc5545.recurrenceset

Class RecurrenceSet

java.lang.Object

org.dmfs.rfc5545.recurrenceset.RecurrenceSet

public class RecurrenceSet
extends java.lang.Object

A recurrence set. A recurrence set consists of all instances defined by a recurrence rule or a list if instances except for exception instances. Exception instances are defined by exceptions rules or lists of exception instances.

This class allows you to add any number of recurrence rules, recurrence instances, exception rules and exception instance. It returns an Iterator that iterates all resulting instances.

Constructor Summary

Constructors

Constructor and Description
RecurrenceSet()

Method Summary

Modifier and Type	Method and Description
void	addExceptions(AbstractRecurrenceAdapter adapter) Add exceptions to the set of instances (i.e. effectively remove instances from the instance set).
void	addInstances(AbstractRecurrenceAdapter adapter) Add instances to the set of instances.
long	getLastInstance(java.util.TimeZone timezone, long start)
boolean	isInfinite() Returns whether this RecurrenceSet contains an infinite number of instances.
RecurrenceSetIterator	iterator(java.util.TimeZone timezone, long start) Get an iterator for the specified start time.
RecurrenceSetIterator	iterator(java.util.TimeZone timezone, long start, long end) Return a new RecurrenceSetIterator for this recurrence set.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurrenceSet

public RecurrenceSet()

Method Detail

addInstances

public void addInstances(AbstractRecurrenceAdapter adapter)

Add instances to the set of instances.

Parameters:

adapter - An AbstractRecurrenceAdapter that defines instances.

addExceptions

public void addExceptions(AbstractRecurrenceAdapter adapter)

Add exceptions to the set of instances (i.e. effectively remove instances from the instance set).

Parameters:

adapter - An AbstractRecurrenceAdapter that defines instances.

iterator

public RecurrenceSetIterator iterator(java.util.TimeZone timezone,
                                      long start)

Get an iterator for the specified start time.

Parameters:

timezone - The TimeZone of the first instance.

start - The start time in milliseconds since the epoch.

Returns:

A RecurrenceSetIterator that iterates all instances.

iterator

public RecurrenceSetIterator iterator(java.util.TimeZone timezone,
                                      long start,
                                      long end)

Return a new RecurrenceSetIterator for this recurrence set.

Parameters:

timezone - The TimeZone of the first instance.

start - The start time in milliseconds since the epoch.

end - The end of the time range to iterate in milliseconds since the epoch.

Returns:

A RecurrenceSetIterator that iterates all instances.

isInfinite

public boolean isInfinite()

Returns whether this RecurrenceSet contains an infinite number of instances.

Returns:

true if the instances in this RecurrenceSet is infinite, false otherwise.

getLastInstance

public long getLastInstance(java.util.TimeZone timezone,
                            long start)