net.time4j.engine.IntElementRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of time4j-core Show documentation
There is a newer version: 4.38
/*
 * -----------------------------------------------------------------------
 * Copyright © 2013-2016 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (IntElementRule.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.engine;


/**
 * Element rule with support for int-primitives. 
 *
 * @param    generic type of time context compatible to {@code ChronoEntity}
 * @author  Meno Hochschild
 * @since   3.15/4.12
 * @doctags.spec    All implementations must be immutable.
 */
/*[deutsch]
 * Repräsentiert eine Elementregel mit Unterstützung
 * für java-int-primitives. 
 *
 * @param    generic type of time context compatible to {@code ChronoEntity}
 * @author  Meno Hochschild
 * @since   3.15/4.12
 * @doctags.spec    All implementations must be immutable.
 */
public interface IntElementRule
    extends ElementRule {

    //~ Methoden ------------------------------------------------------

    /**
     * Yields the current value of associated element in given
     * chronological context. 
     *
     * Will be called by {@link ChronoEntity#getInt(ChronoElement)}. 
     *
     * @param   context     time context to be evaluated
     * @return  current element value as int-primitive
     * @throws  ChronoException if the associated element value cannot be evaluated
     * @since   3.15/4.12
     */
    /*[deutsch]
     * Ermittelt den aktuellen Wert des assoziierten Elements
     * im angegebenen Zeitwertkontext. 
     *
     * Wird von {@link ChronoEntity#getInt(ChronoElement)} aufgerufen. 
     *
     * @param   context     time context to be evaluated
     * @return  current element value as int-primitive
     * @throws  ChronoException if the associated element value cannot be evaluated
     * @since   3.15/4.12
     */
    int getInt(T context);

    /**
     * Queries if given value is valid for the element associated with this
     * rule in given context. 
     *
     * Will be called by {@link ChronoEntity#isValid(ChronoElement, int)}.
     * A numerical overflow causing an {@code ArithmeticException} will usually
     * not be checked. 
     *
     * @param   context     time context to be evaluated
     * @param   value       candidate value to be validated
     * @return  {@code true} if valid else {@code false}
     * @since   3.15/4.12
     */
    /*[deutsch]
     * Ist der angegebene Wert zum mit dieser Regel assoziierten
     * Element im angegebenen Kontext gültig? 
     *
     * Wird von {@link ChronoEntity#isValid(ChronoElement, int)} aufgerufen.
     * Eine numerische Überlaufsituation im Hinblick auf eine {@code ArithmeticException}
     * wird in der Regel nicht geprüft. 
     *
     * @param   context     time context to be evaluated
     * @param   value       candidate value to be validated
     * @return  {@code true} if valid else {@code false}
     * @since   3.15/4.12
     */
    boolean isValid(
        T context,
        int value
    );

    /**
     * Determines the new value of the associated element in given
     * chronological context and yields the result. 
     *
     * Will be called by {@link ChronoEntity#with(ChronoElement, int)}.
     * The lenient mode causes the tolerant interpretation of invalid
     * values like 31st of April as 1st of May. This mode is only
     * active if an element is either explicitly declared as lenient or if
     * the method {@code StdOperator.setLenient()} is used. 
     *
     * @param   context     time context to be evaluated
     * @param   value       new element value
     * @param   lenient     leniency mode
     * @return  changed copy of context which itself remains unaffected
     * @throws  IllegalArgumentException if given value is out of range or
     *          not valid dependent on the given time context
     * @throws  ArithmeticException in case of numerical overflow
     * @see     #isValid(Object, int)
     * @see     StdOperator#setLenient(Object, ChronoElement)
     * @see     ChronoElement#isLenient()
     * @see     net.time4j.ProportionalElement#setLenient(Number)
     * @since   3.15/4.12
     */
    /*[deutsch]
     * Bestimmt den neuen Wert des assoziierten Elements im
     * angegebenen Zeitwertkontext und liefert das Ergebnis. 
     *
     * Wird von {@link ChronoEntity#with(ChronoElement, int)} aufgerufen.
     * Der Nachsichtigkeitsmodus führt dazu, daß eigentlich
     * ungültige Werte wie der 31. April als 1. Mai interpretiert werden.
     * Aktiv ist dieser Modus nur bei Verwendung der einen Operator liefernden
     * Methode {@code StdOperator.setLenient()} oder wenn das Element
     * ausdrücklich als nachsichtig deklariert wird. 
     *
     * @param   context     time context to be evaluated
     * @param   value       new element value
     * @param   lenient     leniency mode
     * @return  changed copy of context which itself remains unaffected
     * @throws  IllegalArgumentException if given value is out of range or
     *          not valid dependent on the given time context
     * @throws  ArithmeticException in case of numerical overflow
     * @see     #isValid(Object, int)
     * @see     StdOperator#setLenient(Object, ChronoElement)
     * @see     ChronoElement#isLenient()
     * @see     net.time4j.ProportionalElement#setLenient(Number)
     * @since   3.15/4.12
     */
    T withValue(
        T context,
        int value,
        boolean lenient
    );

}