TimeZoneNames

abstract class TimeZoneNames : Serializable

TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#35 Unicode Locale Data Markup Language (LDML). The model defines meta zone, which is used for storing a set of display names. A meta zone can be shared by multiple time zones. Also a time zone may have multiple meta zone historic mappings.

For example, people in the United States refer the zone used by the east part of North America as "Eastern Time". The tz database contains multiple time zones "America/New_York", "America/Detroit", "America/Montreal" and some others that belong to "Eastern Time". However, assigning different display names to these time zones does not make much sense for most of people.

In CLDR (which uses LDML for representing locale data), the display name "Eastern Time" is stored as long generic display name of a meta zone identified by the ID "America_Eastern". Then, there is another table maintaining the historic mapping to meta zones for each time zone. The time zones in the above example ("America/New_York", "America/Detroit"...) are mapped to the meta zone "America_Eastern".

Sometimes, a time zone is mapped to a different time zone in the past. For example, "America/Indiana/Knox" had been moving "Eastern Time" and "Central Time" back and forth. Therefore, it is necessary that time zone to meta zones mapping data are stored by date range.

Note:

TimeZoneFormat assumes an instance of TimeZoneNames is immutable. If you want to provide your own TimeZoneNames implementation and use it with TimeZoneFormat, you must follow the contract.

The methods in this class assume that time zone IDs are already canonicalized. For example, you may not get proper result returned by a method with time zone ID "America/Indiana/Indianapolis", because it's not a canonical time zone ID (the canonical time zone ID for the time zone is "America/Indianapolis". See TimeZone.getCanonicalID(String) about ICU canonical time zone IDs.

In CLDR, most of time zone display names except location names are provided through meta zones. But a time zone may have a specific name that is not shared with other time zones. For example, time zone "Europe/London" has English long name for standard time "Greenwich Mean Time", which is also shared with other time zones. However, the long name for daylight saving time is "British Summer Time", which is only used for "Europe/London".

getTimeZoneDisplayName(java.lang.String,android.icu.text.TimeZoneNames.NameType) is designed for accessing a name only used by a single time zone. But is not necessarily mean that a subclass implementation use the same model with CLDR. A subclass implementation may provide time zone names only through getTimeZoneDisplayName(java.lang.String,android.icu.text.TimeZoneNames.NameType), or only through getMetaZoneDisplayName(java.lang.String,android.icu.text.TimeZoneNames.NameType), or both.

The default TimeZoneNames implementation returned by getInstance(android.icu.util.ULocale) uses the locale data imported from CLDR. In CLDR, set of meta zone IDs and mappings between zone IDs and meta zone IDs are shared by all locales. Therefore, the behavior of getAvailableMetaZoneIDs(), getAvailableMetaZoneIDs(java.lang.String), getMetaZoneID(java.lang.String,long), and getReferenceZoneID(java.lang.String,java.lang.String) won't be changed no matter what locale is used for getting an instance of TimeZoneNames.

Summary

Public methods

abstract fun getAvailableMetaZoneIDs(): MutableSet<String!>!

abstract fun getAvailableMetaZoneIDs(tzID: String!): MutableSet<String!>!

fun getDisplayName(
    tzID: String!, 
    type: TimeZoneNames.NameType!, 
    date: Long
): String!

open fun getExemplarLocationName(tzID: String!): String!

open static fun getInstance(locale: ULocale!): TimeZoneNames!

open static fun getInstance(locale: Locale!): TimeZoneNames!

abstract fun getMetaZoneDisplayName(
    mzID: String!, 
    type: TimeZoneNames.NameType!
): String!

abstract fun getMetaZoneID(
    tzID: String!, 
    date: Long
): String!

abstract fun getReferenceZoneID(
    mzID: String!, 
    region: String!
): String!

open static fun getTZDBInstance(locale: ULocale!): TimeZoneNames!

abstract fun getTimeZoneDisplayName(
    tzID: String!, 
    type: TimeZoneNames.NameType!
): String!