com.aldaviva.easter4j.Easter4J Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of easter4j-jodatime Show documentation

The newest version!

package com.aldaviva.easter4j;

import com.aldaviva.easter4j.computus.IanTaylorComputus;
import org.joda.time.LocalDate;

/**
 * Figure out, for a given year, when Easter occurs.
 * Returns Joda-Time {@link org.joda.time.LocalDate} instances.
 *
 * Usage
 *  * Easter4J.{@link #getEaster(int) getEaster}(2016);
 *
 * @see IanTaylorComputus IanTaylorComputus for the underlying implementation
 */
public class Easter4J extends Easter4JBase {

    private Easter4J(){}

    /**
     * Figure out, for a given year, when Easter occurs.
     *
     * Usage
     *      * LocalDate easter = Easter4J.getEaster(2016);
     * assert easter.getMonth() == 3;
     * assert easter.getDayOfMonth() == 27;
     *
     * @param year Non-negative integer representing the Gregorian year e.g. 2016.
     * @return Joda-Time {@link org.joda.time.LocalDate} for the day that Easter occurs on the given year
     * @throws IllegalArgumentException if {@code year} is negative
     */
    public static LocalDate getEaster(final int year) {
        final int dayOfMarch = getEasterAsDayOfMarch(year);
        return new LocalDate(year, 3, 1).plusDays(dayOfMarch - 1);
    }
}