net.time4j.engine.Normalizer 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-2014 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (Normalizer.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;


/**
 * Normalizes a time span. 
 *
 * @param    generic type of time unit compatible to {@link ChronoUnit}
 * @author  Meno Hochschild
 */
/*[deutsch]
 * Normalisiert eine Zeitspanne. 
 *
 * @param    generic type of time unit compatible to {@link ChronoUnit}
 * @author  Meno Hochschild
 */
public interface Normalizer {

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

    /**
     * Normalizes given time span such that the amounts of associated
     * time units are converted in a specific way. 
     *
     * @param   timespan    time span to be normalized
     * @return  normalized copy of argument which itself remains unaffected
     * @see     net.time4j.Duration#with(Normalizer)
     */
    /*[deutsch]
     * Normalisiert die angegebene Zeitspanne so, daß die Beträge
     * der enthaltenen Zeiteinheiten ineinander nach einem spezifischen
     * Verfahren umgerechnet werden. 
     *
     * @param   timespan    time span to be normalized
     * @return  normalized copy of argument which itself remains unaffected
     * @see     net.time4j.Duration#with(Normalizer)
     */
    public TimeSpan normalize(TimeSpan timespan);

}