APIdia Launch Partner
Top Description Constructors Methods
java.util.spi

public abstract Class TimeZoneNameProvider

extends LocaleServiceProvider
Class Inheritance
Known Direct Subclasses
sun.util.locale.provider.SPILocaleProviderAdapter.TimeZoneNameProviderDelegate, sun.util.locale.provider.TimeZoneNameProviderImpl
Imports
java.util.Locale
An abstract class for service providers that provide localized time zone names for the TimeZone class. The localized time zone names available from the implementations of this class are also the source for the DateFormatSymbols.getZoneStrings() method.
Since
1.6

Constructor Summary

AccessConstructor and Description
protected
TimeZoneNameProvider()

Sole constructor.

Method Summary

Modifier and TypeMethod and Description
public abstract String

Returns:

the human-readable name of the given time zone in the given locale, or null if it's not available.
getDisplayName(String
a time zone ID string
ID, boolean
if true, return the daylight saving name.
daylight, int
either TimeZone.LONG or TimeZone.SHORT
style, Locale
the desired locale
locale)

Returns a name for the given time zone ID that's suitable for presentation to the user in the specified locale.

public String

Returns:

the human-readable generic name of the given time zone in the given locale, or null if it's not available.
getGenericDisplayName(String
a time zone ID string
ID, int
either TimeZone.LONG or TimeZone.SHORT
style, Locale
the desired locale
locale)

Returns a generic name for the given time zone ID that's suitable for presentation to the user in the specified locale.

Inherited from java.util.spi.LocaleServiceProvider:
getAvailableLocalesisSupportedLocale

Constructor Detail

TimeZoneNameProviderback to summary
protected TimeZoneNameProvider()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

getDisplayNameback to summary
public abstract String getDisplayName(String ID, boolean daylight, int style, 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 https://www.iana.org/time-zones. 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.

Parameters
ID:String

a time zone ID string

daylight:boolean

if true, return the daylight saving name.

style:int

either TimeZone.LONG or TimeZone.SHORT

locale:Locale

the desired locale

Returns:String

the human-readable name of the given time zone in the given locale, or null if it's not available.

Exceptions
IllegalArgumentException:
if style is invalid, or locale isn't one of the locales returned from getAvailableLocales().
NullPointerException:
if ID or locale is null
External Specification
https://www.iana.org/time-zones
See Also
java.util.TimeZone#getDisplayName(boolean, int, java.util.Locale)
getGenericDisplayNameback to summary
public String getGenericDisplayName(String ID, int style, Locale locale)

Returns a generic name for the given time zone ID that's suitable for presentation to the user in the specified locale. Generic time zone names are neutral from standard time and daylight saving time. For example, "PT" is the short generic name of time zone ID America/Los_Angeles, while its short standard time and daylight saving time names are "PST" and "PDT", respectively. Refer to getDisplayName for valid time zone IDs.

The default implementation of this method returns null.

Parameters
ID:String

a time zone ID string

style:int

either TimeZone.LONG or TimeZone.SHORT

locale:Locale

the desired locale

Returns:String

the human-readable generic name of the given time zone in the given locale, or null if it's not available.

Exceptions
IllegalArgumentException:
if style is invalid, or locale isn't one of the locales returned from getAvailableLocales().
NullPointerException:
if ID or locale is null
Since
1.8