Package net.fortuna.ical4j.transform.recurrence

Class ByMonthRule

java.lang.Object

net.fortuna.ical4j.transform.recurrence.AbstractDateExpansionRule

net.fortuna.ical4j.transform.recurrence.ByMonthRule

All Implemented Interfaces:

Serializable, Function<DateList,DateList>, UnaryOperator<DateList>, Transformer<DateList>

public class ByMonthRule
extends AbstractDateExpansionRule

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ByMonthRule(MonthList monthList, Recur.Frequency frequency)
ByMonthRule(MonthList monthList, Recur.Frequency frequency, Optional<WeekDay.Day> weekStartDay)
ByMonthRule(MonthList monthList, Recur.Frequency frequency, Optional<WeekDay.Day> weekStartDay, Recur.Skip skip)
ByMonthRule(MonthList monthList, Recur.Frequency frequency, Recur.Skip skip)

Method Summary

Modifier and Type	Method	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, getTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface net.fortuna.ical4j.transform.Transformer

apply

Constructor Details

ByMonthRule

public ByMonthRule(MonthList monthList,
 Recur.Frequency frequency)

ByMonthRule

public ByMonthRule(MonthList monthList,
 Recur.Frequency frequency,
 Recur.Skip skip)

ByMonthRule

public ByMonthRule(MonthList monthList,
 Recur.Frequency frequency,
 Optional<WeekDay.Day> weekStartDay)

ByMonthRule

public ByMonthRule(MonthList monthList,
 Recur.Frequency frequency,
 Optional<WeekDay.Day> weekStartDay,
 Recur.Skip skip)

Method Details

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