net.fortuna.ical4j.transform.recurrence

Class ByDayRule

java.lang.Object

net.fortuna.ical4j.transform.recurrence.AbstractDateExpansionRule

net.fortuna.ical4j.transform.recurrence.ByDayRule

All Implemented Interfaces:

java.io.Serializable, Transformer<DateList>

public class ByDayRule
extends AbstractDateExpansionRule

Applies BYDAY rules specified in this Recur instance to the specified date list. If no BYDAY rules are specified the date list is returned unmodified.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByDayRule(WeekDayList dayList, Recur.Frequency frequency)
ByDayRule(WeekDayList dayList, Recur.Frequency frequency, java.util.Optional<WeekDay.Day> weekStartDay)

Method Summary

Modifier and Type	Method and Description
DateList	transform(DateList dates) Transforms the specified calendar object according to the implementation of this method.

Methods inherited from class net.fortuna.ical4j.transform.recurrence.AbstractDateExpansionRule

getCalendarInstance, getFrequency

Methods inherited from class java.lang.Object

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

Constructor Detail

ByDayRule

public ByDayRule(WeekDayList dayList,
                 Recur.Frequency frequency)

ByDayRule

public ByDayRule(WeekDayList dayList,
                 Recur.Frequency frequency,
                 java.util.Optional<WeekDay.Day> weekStartDay)

Method Detail

transform

public DateList transform(DateList dates)

Description copied from interface: Transformer

Transforms the specified calendar object according to the implementation of this method.

Parameters:

dates - a calendar object to transform

Returns:

a transformed calendar object