net.time4j.tz.NameStyle Maven / Gradle / Ivy

Go to download
/*
 * -----------------------------------------------------------------------
 * Copyright © 2014-2017 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (NameStyle.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.tz;


/**
 * Defines the style of a timezone name. 
 *
 * @author  Meno Hochschild
 */
/*[deutsch]
 * Definiert den Stil eines Zeitzonennamens. 
 *
 * @author  Meno Hochschild
 */
public enum NameStyle {

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

    /**
     * Abbreviation in winter time (standard time). 
     *
     * Example: CET 
     */
    /*[deutsch]
     * Abkürzung in der Winterzeit (Normalzeit). 
     *
     * Beispiel: MEZ 
     */
    SHORT_STANDARD_TIME,

    /**
     * Long name in winter time (standard time). 
     *
     * Example: Central European Time 
     */
    /*[deutsch]
     * Langer Name in der Winterzeit (Normalzeit). 
     *
     * Beispiel: Mitteleuropäische Zeit 
     */
    LONG_STANDARD_TIME,

    /**
     * Abbreviation in summer time (daylight saving). 
     *
     * Example: CEST 
     */
    /*[deutsch]
     * Abkürzung in der Sommerzeit. 
     *
     * Beispiel: MESZ 
     */
    SHORT_DAYLIGHT_TIME,

    /**
     * Long name in summer time (daylight saving). 
     *
     * Example: Central European Summer Time 
     */
    /*[deutsch]
     * Langer Name in der Sommerzeit. 
     *
     * Beispiel: Mitteleuropäische Sommerzeit 
     */
    LONG_DAYLIGHT_TIME,

    /**
     * Abbreviation without making a difference between winter or summer time. 
     *
     * @since   4.23
     */
    /*[deutsch]
     * Abkürzung, die nicht zwischen Winter- oder Sommerzeit unterscheidet. 
     *
     * @since   4.23
     */
    SHORT_GENERIC_TIME,

    /**
     * Long name without making a difference between winter or summer time. 
     *
     * @since   4.23
     */
    /*[deutsch]
     * Langer Name, der nicht zwischen Winter- oder Sommerzeit unterscheidet. 
     *
     * @since   4.23
     */
    LONG_GENERIC_TIME;

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

    /**
     * Does this style denote an abbreviation? 
     *
     * @return  boolean
     */
    /*[deutsch]
     * Liegt eine Abkürzung vor? 
     *
     * @return  boolean
     */
    public boolean isAbbreviation() {

        return ((this == SHORT_STANDARD_TIME) || (this == SHORT_DAYLIGHT_TIME) || (this == SHORT_GENERIC_TIME));

    }

    /**
     * Does this style denote a daylight saving time? 
     *
     * @return  boolean
     * @see     #SHORT_DAYLIGHT_TIME
     * @see     #LONG_DAYLIGHT_TIME
     */
    /*[deutsch]
     * Liegt eine Sommerzeitform vor? 
     *
     * @return  boolean
     * @see     #SHORT_DAYLIGHT_TIME
     * @see     #LONG_DAYLIGHT_TIME
     */
    public boolean isDaylightSaving() {

        return ((this == SHORT_DAYLIGHT_TIME) || (this == LONG_DAYLIGHT_TIME));

    }

}