net.time4j.OverflowPolicy Maven / Gradle / Ivy

Go to download
/*
 * -----------------------------------------------------------------------
 * Copyright © 2013-2014 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (OverflowPolicy.java) is part of project Time4J.
 *
 * Time4J is free software: You can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Time4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Time4J. If not, see .
 * -----------------------------------------------------------------------
 */

package net.time4j;

/**
 * Handles the day overflow at the end of month after an addition to
 * a calendar date. 
 *
 * @author  Meno Hochschild
 * @see     CalendarUnit
 */
enum OverflowPolicy {

    //~ Statische Felder/Initialisierungen --------------------------------

    /**
     * Standard policy which resets the invalid day of month to the previous
     * valid one.
     */
    PREVIOUS_VALID_DATE,

    /**
     * Resolves the invalid day of month to the next valid one.
     */
    NEXT_VALID_DATE,

    /**
     * Always moves the day of month to the last day of month even if valid.
     */
    END_OF_MONTH,

    /**
     * Any carry-over will be transferred to the next month.
     */
    CARRY_OVER,

    /**
     * This policy causes an exception in case of day overflow.
     */
    UNLESS_INVALID,

    /**
     * Moves the day of month to the last day of month if the original date
     * is the last day of month.
     *
     * @since   2.3
     */
    KEEPING_LAST_DATE;

}