net.bluemind.calendar.occurrence

Class OccurrenceHelper

java.lang.Object

net.bluemind.calendar.occurrence.OccurrenceHelper

public class OccurrenceHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OccurrenceHelper()

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<VEventOccurrence>	getNextOccurrence(BmDateTime start, VEvent event) Returns the first occurrence of {event} occurring after {start} or {Optional.Empty} if there is none.
static VEventOccurrence	getOccurrence(ItemValue<VEventSeries> event, BmDateTime dtstart) Returns an occurrence of a recurring event that occurs a specific date.
static java.util.Optional<VEventOccurrence>	getOccurrenceByRecurId(ItemValue<VEventSeries> event, BmDateTime recurid) Returns an occurrence of a recurring event with a specific recurid.
static java.util.List<VEvent>	list(ItemValue<VEventSeries> event, BmDateTime dtstart, BmDateTime dtend) Returns a list of occurrences of a recurring event.

Methods inherited from class java.lang.Object

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

Constructor Detail

OccurrenceHelper

public OccurrenceHelper()

Method Detail

list

public static java.util.List<VEvent> list(ItemValue<VEventSeries> event,
                                          BmDateTime dtstart,
                                          BmDateTime dtend)

Returns a list of occurrences of a recurring event.

Parameters:

event - the recurring event

dtstart - the start date of the period

dtend - the end date of the period

Returns:

a list of VEvent

getOccurrence

public static VEventOccurrence getOccurrence(ItemValue<VEventSeries> event,
                                             BmDateTime dtstart)

Returns an occurrence of a recurring event that occurs a specific date.

Parameters:

event - the event

dtstart - the expected occurrence date

Returns:

an VEvent if the recurring event occurs at BmDateTime occurrenceDtstart. Returns null otherwise.

getOccurrenceByRecurId

public static java.util.Optional<VEventOccurrence> getOccurrenceByRecurId(ItemValue<VEventSeries> event,
                                                                          BmDateTime recurid)

Returns an occurrence of a recurring event with a specific recurid.

Parameters:

event - the event

recurid - the expected occurrence date

Returns:

an VEvent if the recurring event occurs at BmDateTime occurrenceDtstart. Returns null otherwise.

getNextOccurrence

public static java.util.Optional<VEventOccurrence> getNextOccurrence(BmDateTime start,
                                                                     VEvent event)

Returns the first occurrence of {event} occurring after {start} or {Optional.Empty} if there is none.

Parameters:

start -

event -

Returns: