net.time4j.ZonalElement 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 (ZonalElement.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;

import net.time4j.engine.ChronoElement;
import net.time4j.engine.ChronoFunction;
import net.time4j.tz.TZID;
import net.time4j.tz.Timezone;
import net.time4j.tz.ZonalOffset;


/**
 * Extends a chronological element by some zonal queries. 
 *
 * @param    generic type of element values
 * @author  Meno Hochschild
 * @since   2.0
 */
/*[deutsch]
 * Erweitert ein chronologisches Element um diverse zonale Abfragen. 
 *
 * @param    generic type of element values
 * @author  Meno Hochschild
 * @since   2.0
 */
public interface ZonalElement
    extends ChronoElement {

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

    /**
     * Creates a function which can query a {@link Moment} in the
     * system timezone. 
     *
     * Note: Usually the function converts the given {@code Moment} to
     * a {@code PlainTimestamp} and then queries this local timestamp. 
     *
     * @return  function with the default system timezone reference,
     *          applicable on instances of {@code Moment}
     * @since   2.0
     */
    /*[deutsch]
     * Erzeugt eine Funktion, die einen {@link Moment} mit
     * Hilfe der Systemzeitzonenreferenz abfragen kann. 
     *
     * Hinweis: Die Funktion wandelt meist den gegebenen {@code Moment}
     * in einen lokalen Zeitstempel um und fragt dann diesen ab. 
     *
     * @return  function with the default system timezone reference,
     *          applicable on instances of {@code Moment}
     * @since   2.0
     */
    ChronoFunction inStdTimezone();

    /**
     * Creates a function which can query a {@link Moment} in the
     * given timezone. 
     *
     * Note: Usually the function converts the given {@code Moment} to
     * a {@code PlainTimestamp} and then queries this zonal timestamp. 
     *
     * @param   tzid        timezone id
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     * @throws  IllegalArgumentException if given timezone cannot be loaded
     */
    /*[deutsch]
     * Erzeugt eine Funktion, die einen {@link Moment} mit
     * Hilfe einer Zeitzonenreferenz abfragen kann. 
     *
     * Hinweis: Die Funktion wandelt meist den gegebenen {@code Moment}
     * in einen zonalen Zeitstempel um und fragt dann diesen ab. 
     *
     * @param   tzid        timezone id
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     * @throws  IllegalArgumentException if given timezone cannot be loaded
     */
    ChronoFunction inTimezone(TZID tzid);

    /**
     * Creates a function which can query a {@link Moment} in the
     * given timezone. 
     *
     * Note: Usually the function converts the given {@code Moment} to
     * a {@code PlainTimestamp} and then queries this zonal timestamp. 
     *
     * @param   tz          timezone
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     */
    /*[deutsch]
     * Erzeugt eine Funktion, die einen {@link Moment} mit
     * Hilfe einer Zeitzonenreferenz abfragen kann. 
     *
     * Hinweis: Die Funktion wandelt meist den gegebenen {@code Moment}
     * in einen zonalen Zeitstempel um und fragt dann diesen ab. 
     *
     * @param   tz          timezone
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     */
    ChronoFunction in(Timezone tz);

    /**
     * Equivalent to {@code at(ZonalOffset.UTC)}. 
     *
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     * @see     #at(ZonalOffset)
     */
    /*[deutsch]
     * Äquivalent zu {@code at(ZonalOffset.UTC)}. 
     *
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     * @see     #at(ZonalOffset)
     */
    ChronoFunction atUTC();

    /**
     * Creates a function which can query a {@link Moment} at the
     * given timezone offset. 
     *
     * Note: Usually the function converts the given {@code Moment} to
     * a {@code PlainTimestamp} and then queries this zonal timestamp. 
     *
     * @param   offset  timezone offset
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     */
    /*[deutsch]
     * Erzeugt einen Operator, der einen {@link Moment} mit
     * Hilfe eines Zeitzonen-Offsets anpassen kann. 
     *
     * Hinweis: Die Funktion wandelt meist den gegebenen {@code Moment}
     * in einen zonalen Zeitstempel um und fragt dann diesen ab. 
     *
     * @param   offset  timezone offset
     * @return  function applicable on instances of {@code Moment}
     * @since   2.0
     */
    ChronoFunction at(ZonalOffset offset);

}