001 /* TimeZoneNameProvider.java -- Providers of localized currency symbols
002 Copyright (C) 2007 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.util.spi;
039
040 import java.util.Locale;
041
042 /**
043 * A {@link TimeZoneNameProvider} provides localized
044 * versions of the names that represent a particular
045 * timezone. A <code>null</code> value may
046 * be returned, which should be treated as a lack of
047 * support for the specified {@link Locale}. The names
048 * from this class are also used by
049 * {@link DateFormatSymbols#getZoneStrings()}.
050 *
051 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
052 * @since 1.6
053 */
054 public abstract class TimeZoneNameProvider
055 extends LocaleServiceProvider
056 {
057
058 /**
059 * Constructs a new {@link TimeZoneNameProvider}.
060 * Provided for implicit invocation by subclasses.
061 */
062 protected TimeZoneNameProvider()
063 {
064 }
065
066 /**
067 * Returns a name for the specified time zone identifier
068 * localized to the supplied {@link java.util.Locale}.
069 * The time zone identifier is either <code>"GMT"</code>
070 * or one of the identifiers from the public domain "tz
071 * database" found at <a href="ftp://elsie.nci.nih.gov/pub/">
072 * ftp://elsie.nci.nih.gov/pub</a>. Note that a translated
073 * name for the daylight savings time variant should be returned,
074 * even if the timezone has not observed daylight savings
075 * time in the past. If the name of the timezone
076 * in the given locale is not supported, <code>null</code>
077 * is returned.
078 *
079 * @param id a time zone identifier.
080 * @param daylight true if the daylight savings time variant
081 * should be returned.
082 * @param style either {@link java.util.TimeZone.LONG} or
083 * {@link java.util.TimeZone.SHORT}
084 * @param locale the locale to express the timezone in.
085 * @return the localized time zone name, or <code>null</code>
086 * if one is not available.
087 * @throws NullPointerException if the identifer or locale is null.
088 * @throws IllegalArgumentException if the style is invalid
089 * or the locale is not one
090 * returned by
091 * {@link getAvailableLocales()}
092 * @see java.util.TimeZone#getDisplayName(boolean,int,java.util.Locale)
093 */
094 public abstract String getDisplayName(String id, boolean daylight,
095 int style, Locale locale);
096
097 }