From 776ccceb02aed9322d6ddeb8b6c05210d7df70e9 Mon Sep 17 00:00:00 2001 From: Ben Fortuna Date: Tue, 9 Jul 2024 20:59:39 +1000 Subject: [PATCH] Added components feature --- docs/components.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/components.md b/docs/components.md index 2bdd9f5b..0721fce5 100644 --- a/docs/components.md +++ b/docs/components.md @@ -74,3 +74,17 @@ todo.with(CATEGORIES, new Categories("travel")); | DescriptivePropertyModifiers | `ATTACH`, `CATEGORIES`, `DESCRIPTION`, `SUMMARY` | | RecurrencePropertyModifiers | `EXDATE`, `RDATE`, `RRULE` | | RelationshipPropertyModifiers | `ATTENDEE`, `CONTACT`, `ORGANIZER`, `RECURRENCE-ID`, `RELATED-TO`, `URL` | + +## Recurrence Support + +Some components support the concept of recurrence, which may be defined by the inclusion of `RRULE`, +`RDATE` and/or `EXDATE` properties. Components that support these properties also implement the +`RecurrenceSupport` interface which defines methods for calculating discrete occurrences. + +```java +Period period = new Period("20230301/P1M"); + +List occurrences = event.getOccurrences(period); + +Set recurrenceSet = event.calculateRecurrenceSet(period); +``` \ No newline at end of file