FileDocCategorySizeDatePackage
TimeZoneNameProvider.javaAPI DocJava SE 6 API2713Tue Jun 10 00:26:00 BST 2008java.util.spi

TimeZoneNameProvider

public abstract class TimeZoneNameProvider extends LocaleServiceProvider
An abstract class for service providers that provide localized time zone names for the {@link java.util.TimeZone TimeZone} class. The localized time zone names available from the implementations of this class are also the source for the {@link java.text.DateFormatSymbols#getZoneStrings() DateFormatSymbols.getZoneStrings()} method.
since
1.6
version
@(#)TimeZoneNameProvider.java 1.2 05/11/17

Fields Summary
Constructors Summary
protected TimeZoneNameProvider()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Methods Summary
public abstract java.lang.StringgetDisplayName(java.lang.String ID, boolean daylight, int style, java.util.Locale locale)
Returns a name for the given time zone ID that's suitable for presentation to the user in the specified locale. The given time zone ID is "GMT" or one of the names defined using "Zone" entries in the "tz database", a public domain time zone database at ftp://elsie.nci.nih.gov/pub/. The data of this database is contained in a file whose name starts with "tzdata", and the specification of the data format is part of the zic.8 man page, which is contained in a file whose name starts with "tzcode".

If daylight is true, the method should return a name appropriate for daylight saving time even if the specified time zone has not observed daylight saving time in the past.

param
ID a time zone ID string
param
daylight if true, return the daylight saving name.
param
style either {@link java.util.TimeZone#LONG TimeZone.LONG} or {@link java.util.TimeZone#SHORT TimeZone.SHORT}
param
locale the desired locale
return
the human-readable name of the given time zone in the given locale, or null if it's not available.
exception
IllegalArgumentException if style is invalid, or locale isn't one of the locales returned from {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
exception
NullPointerException if ID or locale is null
see
java.util.TimeZone#getDisplayName(boolean, int, java.util.Locale)