net.fortuna.ical4j.extensions.property.Repeats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ical4j-extensions Show documentation
Support for additional non-standard iCalendar objects
There is a newer version: 2.0.0
package net.fortuna.ical4j.extensions.property;

import net.fortuna.ical4j.model.Parameter;
import net.fortuna.ical4j.model.Property;
import net.fortuna.ical4j.model.Recur;
import net.fortuna.ical4j.model.WeekDay;
import net.fortuna.ical4j.model.property.ImmutableProperty;
import net.fortuna.ical4j.model.property.RRule;
import net.fortuna.ical4j.transform.recurrence.Frequency;
import org.threeten.extra.*;

import java.time.DayOfWeek;
import java.time.LocalDate;
import java.time.Month;
import java.time.temporal.Temporal;
import java.util.Arrays;
import java.util.stream.Collectors;

import static java.time.DayOfWeek.*;

/**
 * Repeats is an immutable subclass of {@link RRule} to support common use-cases.
 *
 * @param  the temporal type to which this rule will be applied
 */
public class Repeats extends RRule implements ImmutableProperty {

    public static final Repeats YEARLY = new Repeats<>(Years.ONE);

    public static final Repeats HALF_YEARLY = new Repeats<>(Months.of(6));

    public static final Repeats QUARTERLY = new Repeats<>(Months.of(3));

    public static final Repeats MONTHLY = new Repeats<>(Months.ONE);

    public static final Repeats FORTNIGHTLY = new Repeats<>(Weeks.of(2));

    public static final Repeats WEEKLY = new Repeats<>(Weeks.ONE);

    public static final Repeats DAILY = new Repeats<>(Days.ONE);

    public static final Repeats TWICE_DAILY = new Repeats<>(Hours.of(12));

    public static final Repeats HOURLY = new Repeats<>(Hours.of(1));

    public static final Repeats MINUTELY = new Repeats<>(Minutes.of(1));

    public static final Repeats SECONDLY = new Repeats<>(Seconds.of(1));

    public static final Repeats WEEKDAYS = new Repeats(Weeks.ONE)
            .on(MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY);

    public static final Repeats WEEKENDS = new Repeats(Weeks.ONE)
            .on(SATURDAY, SUNDAY);

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Years interval) {
        this(new Recur.Builder<>().frequency(Frequency.YEARLY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Months interval) {
        this(new Recur.Builder<>().frequency(Frequency.MONTHLY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Weeks interval) {
        this(new Recur.Builder<>().frequency(Frequency.WEEKLY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Days interval) {
        this(new Recur.Builder<>().frequency(Frequency.DAILY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Hours interval) {
        this(new Recur.Builder<>().frequency(Frequency.HOURLY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Minutes interval) {
        this(new Recur.Builder<>().frequency(Frequency.MINUTELY)
                .interval(interval.getAmount()).build());
    }

    /**
     * How often the recurrence repeats (i.e. interval).
     *
     * @param interval
     */
    public Repeats(Seconds interval) {
        this(new Recur.Builder<>().frequency(Frequency.SECONDLY)
                .interval(interval.getAmount()).build());
    }

    private Repeats(Recur recur) {
        setRecur(recur);
    }

    @Override
    public  P add(Parameter parameter) {
        return ImmutableProperty.super.add(parameter);
    }

    @Override
    public 
 P remove(Parameter parameter) {
        return ImmutableProperty.super.remove(parameter);
    }

    @Override
    public 
 P removeAll(String... parameterName) {
        return ImmutableProperty.super.removeAll(parameterName);
    }

    @Override
    public  P replace(Parameter parameter) {
        return ImmutableProperty.super.replace(parameter);
    }

    /**
     * On which day of the week the recurrence repeats (BYDAY).
     *
     * @param day
     */
    public Repeats on(DayOfWeek... day) {
        return new Repeats<>(new Recur.Builder<>(getRecur()).dayList(Arrays.stream(day).map(WeekDay::getWeekDay)
                .collect(Collectors.toList())).build());
    }

    /**
     * On which day of the month the recurrence repeats (BYMONTHDAY).
     *
     * @param dayOfMonth
     */
    public Repeats on(Integer... dayOfMonth) {
        return new Repeats<>(new Recur.Builder<>(getRecur()).monthDayList(Arrays.asList(dayOfMonth)).build());
    }

    public Repeats on(Month... month) {
        return new Repeats<>(new Recur.Builder<>(getRecur()).monthList(Arrays.stream(month)
                .map(m -> net.fortuna.ical4j.model.Month.valueOf(m.getValue()))
                .collect(Collectors.toList())).build());
    }

    /**
     * The end date of the recurrence (i.e. until).
     *
     * @param endDate
     * @return
     */
    public Repeats until(T endDate) {
        return new Repeats<>(new Recur.Builder<>(getRecur()).until(endDate).build());
    }

    /**
     * The total number of occurrences (i.e. count).
     *
     * @param count
     * @return
     */
    public Repeats times(int count) {
        return new Repeats<>(new Recur.Builder<>(getRecur()).count(count).build());
    }
}